Expand the documentation FAQ
Author: FenjuFuCreated Jun 15, 2026Updated Sep 1, 2026
Labelsdocumentationgood first issue
Expand the documentation FAQ
The FAQ pages — docs/faq.md (English)
and docs/zh/faq.md (中文) — are a
high-traffic landing spot for new users. Help us grow them with real questions people hit.
What to do
- Pick one or two common questions — good sources are Discussions, recently closed issues, or anything that tripped you up during setup.
- Add a clear question + answer to
docs/faq.md(English). - Mirror the same entry in
docs/zh/faq.md(中文) at the same position. Only comfortable in one language? Add that one and say so in your PR — someone can add the other. - Preview locally:
cd docs && npm run docs:dev
Good candidates
- Common deployment / environment-variable pitfalls
- "Which model do I need and where do I put the credentials?"
- How to import a workflow from the examples gallery
- Differences between the deployment guide variants (with/without auth, with RPA)
Small, self-contained, and genuinely useful — a perfect first PR. Tip: every page has an "Edit this page on GitHub" link at the bottom for a one-click start.
Source: iflytek/astron-agent