Contribute to the docs
You can fix incorrect steps, add missing explanations, verify hardware wiring, or help translate. Small corrections are useful too.
Report an issue
Use “Report a documentation issue” below an article. Include the page URL, the affected section, and the device model and firmware version when relevant. Describe what happened and what you expected.
Submit a correction
- Select “Edit this page on GitHub” below the article.
- Edit the Markdown and open a pull request. GitHub will guide first-time contributors through creating a fork.
- Explain the change and how you verified it. Once maintainers review and merge it, the website updates automatically.
See the repository contribution guide for the complete writing and submission process.
Help translate
Chinese and English articles use matching paths. Follow the shared terminology and keep code, pin names, board identifiers, and file names unchanged. Screenshots also need to match the target language; translating the text alone is not enough.
Start by reviewing a single article. If you find a technical error, point out the corresponding issue in the Chinese source too.