|
| 1 | +--- |
| 2 | +title: "Contributing" |
| 3 | +description: "Learn how to contribute to Mintlify documentation and help improve the developer experience" |
| 4 | +icon: "heart" |
| 5 | +--- |
| 6 | + |
| 7 | +We welcome contributions to Mintlify documentation! Whether you're fixing a typo, improving an explanation, or adding new content, your help makes our documentation better for everyone. |
| 8 | + |
| 9 | +## Ways to contribute |
| 10 | + |
| 11 | +### Report issues |
| 12 | + |
| 13 | +Found a problem with our documentation? Help us fix it: |
| 14 | + |
| 15 | +- **Broken links**: Report any links that don't work |
| 16 | +- **Outdated information**: Let us know if content is no longer accurate |
| 17 | +- **Missing information**: Suggest topics that need better coverage |
| 18 | +- **Unclear explanations**: Point out sections that could be clearer |
| 19 | + |
| 20 | +[Report an issue on GitHub](https://github.com/mintlify/docs/issues/new) |
| 21 | + |
| 22 | +### Suggest improvements |
| 23 | + |
| 24 | +Have ideas for making our documentation better? |
| 25 | + |
| 26 | +- **New guides**: Suggest tutorials or guides that would help users |
| 27 | +- **Better examples**: Propose more practical or clearer code examples |
| 28 | +- **UI improvements**: Share ideas for better navigation or layout |
| 29 | +- **Content organization**: Suggest ways to restructure information |
| 30 | + |
| 31 | +[Start a discussion on GitHub](https://github.com/mintlify/docs/discussions) |
| 32 | + |
| 33 | +### Submit changes |
| 34 | + |
| 35 | +Ready to contribute directly? Here's how: |
| 36 | + |
| 37 | +1. **Fork the repository**: Create your own copy of the [docs repository](https://github.com/mintlify/docs) |
| 38 | +2. **Make your changes**: Edit the relevant MDX files |
| 39 | +3. **Test locally**: Run `mint dev` to preview your changes |
| 40 | +4. **Submit a pull request**: Describe your changes and why they're helpful |
| 41 | + |
| 42 | +### Documentation standards |
| 43 | + |
| 44 | +When contributing, please follow these guidelines: |
| 45 | + |
| 46 | +- **Use second-person voice**: Write "you" instead of "the user" |
| 47 | +- **Keep headings in sentence case**: "Getting started" not "Getting Started" |
| 48 | +- **Include code examples**: Show practical implementations |
| 49 | +- **Add alt text to images**: Make content accessible |
| 50 | +- **Test all links**: Ensure external links work correctly |
| 51 | + |
| 52 | +## Getting help |
| 53 | + |
| 54 | +Need help with your contribution? |
| 55 | + |
| 56 | +- **Join our community**: Connect with other contributors and maintainers |
| 57 | +- **Ask questions**: Use GitHub discussions for questions about contributing |
| 58 | +- **Review existing issues**: See what others are working on |
| 59 | + |
| 60 | +## Recognition |
| 61 | + |
| 62 | +We appreciate all contributions! Contributors are recognized in: |
| 63 | + |
| 64 | +- **GitHub contributors list**: Automatic recognition for merged pull requests |
| 65 | +- **Release notes**: Major contributions highlighted in updates |
| 66 | +- **Community showcases**: Outstanding contributions featured in our community |
| 67 | + |
| 68 | +## Code of conduct |
| 69 | + |
| 70 | +We're committed to providing a welcoming and inclusive environment. Please: |
| 71 | + |
| 72 | +- **Be respectful**: Treat all community members with kindness |
| 73 | +- **Be constructive**: Provide helpful feedback and suggestions |
| 74 | +- **Be patient**: Remember that everyone is learning and contributing in their spare time |
| 75 | + |
| 76 | +## License |
| 77 | + |
| 78 | +By contributing to Mintlify documentation, you agree that your contributions will be licensed under the same terms as the project. |
| 79 | + |
| 80 | +--- |
| 81 | + |
| 82 | +Thank you for helping make Mintlify documentation better for everyone! 🎉 |
0 commit comments