📖 This page outlines the essential requirements for contributing to or utilizing our documentation.
Key Requirements
📋 Content Standards:
- All documentation must be written in clear, concise language.
- Use consistent formatting (e.g., headers, lists, code blocks).
- Avoid any sensitive or restricted topics (e.g., politics, pornography).
📦 Structure Requirements:
- Include a Table of Contents for long documents.
- Use markdown syntax for code examples and API references.
- Add relevant images to illustrate concepts (see below).
📝 Best Practices:
- Always cite sources when referencing external materials.
- Keep updates to the /en/docs/roadmap for tracking progress.
- Use 🌐 for global audiences and 🇨🇳 for region-specific guidelines.
Example Images
Related Resources
🔗 Explore the introduction to understand the foundation of our documentation framework.
🔗 Review the roadmap for upcoming updates and features.
For further assistance, contact our support team via Support Portal.