Thank you for your interest in contributing to the Docs repository! This project aims to provide high-quality documentation for AI models, and your contributions are invaluable in achieving this goal.
We welcome the following types of contributions:
- Adding documentation for new technologies
- Updating existing documentation
- Improving formatting and structure
- Fixing errors
- Adding examples
-
Choose an Issue: Start by looking at open issues or create a new one describing what you want to contribute.
-
Work on Your Contribution:
- Follow directory structure standards
-
Submit a Pull Request:
- Push your changes to your fork
- Submit a pull request to the main repository
- Include a clear description of the changes
- Include a link to the original doc(s) source
- Reference any related issues
-
Address Review Feedback:
- Be responsive to review comments
- Make requested changes promptly
- Ask for clarification if needed
New documentation should follow the established directory structure:
category/
└── technology/
└── version/
└── topic.md
For example:
languages/
└── python/
└── 3.11/
└── standard-library/
└── asyncio.md
- Peer Review: Review by at least one other contributor
- Maintainer Review: Final review by a repository maintainer
- Iteration: Address any feedback from reviewers
- Approval and Merge: Changes merged by maintainers after approval