We welcome contributions to improve our documentation! This site is powered by GitBook and synced with our GitHub repository.
The fastest way to contribute is through our documentation site:
- Visit docs.near-intents.org
- Navigate to the page you want to edit
- Click "Edit in GitHub"
- Make your changes and submit a pull request
For larger changes or multiple file edits:
- Fork this repository
- Create a new branch:
git checkout -b feature/your-improvement - Make your changes
- Commit with a clear message:
git commit -m "Add section on X" - Push to your fork:
git push origin feature/your-improvement - Open a pull request with a descriptive title and summary
We appreciate contributions that:
- Fix errors - typos, broken links, outdated information
- Improve clarity - better explanations, examples, or code snippets
- Add missing content - new sections, FAQ answers, troubleshooting guides
- Enhance organization - better structure, navigation, or categorization
- Use clear, concise language - write for developers of all experience levels
- Include code examples where helpful, with proper syntax highlighting
- Follow existing formatting - maintain consistency with the current style
- Test all links and code before submitting
- Use a descriptive title - "Fix typo in API docs" rather than "Update docs"
- Provide context - explain what you changed and why
- Reference issues - mention any related GitHub issues
- Keep changes focused - one topic per PR when possible
- Join our community Telegram Support
- Open an issue for discussion before making large changes