Welcome to the contribution guide! If you're passionate about improving our documentation, you're in the right place. Here's how you can help:
🌟 Why Contribute?
- Enhance clarity for users worldwide
- Expand knowledge by adding new topics
- Fix errors and outdated information
- Collaborate with the community to grow together
💡 Need inspiration? Check out our documentation examples for reference.
🧰 How to Get Started
- Fork the repo on GitHub
- Clone your fork locally
- Edit the relevant files in
/docs
- Test your changes before submitting
- Push to your branch and create a PR
📌 Documentation Guidelines
- Follow the style guide for consistency
- Use clear and concise language
- Include code examples where applicable
- Add images to illustrate complex concepts (e.g.,
contributing_guide
ordocumentation_flow
)
📚 Common Questions
- What format should I use? Markdown is preferred!
- How do I add a new section? Edit the
index.md
file. - Can I contribute translations? Yes! See the translation guide.
Let’s make documentation better together! 🤝
Need more guidance? Explore our Chinese version for detailed steps. 🌏