Documentation Maintenance
Read the root
AGENTS.md,docs/AGENTS.md, and the relevant documentation, implementation, schema, and tests before editing.Keep Chinese pages and their
docs/en/counterparts behaviorally aligned. Preserve option names, JSON keys, CLI flags, provider IDs, and examples.For new or removed pages, update both locale navigation and sidebars in
docs/.vitepress/config.mts, then updatedocs/llms.txt.Use relative links for internal documentation and full URLs for external destinations. Keep each locale within its own documentation tree.
Edit source content only: root
README.mdandREADME.en.mdgenerate the documentation home pages; do not edit or commitdocs/.vitepress/dist/.Treat
docs/public/install.shanddocs/esa.jsas executable code. Preserve their runtime contracts and review downloads, redirects, caching, and inputs.When dependency installation is permitted, validate with:
npm --prefix docs ci npm --prefix docs run build
Report changed files and any validation not run.