Gen Docs

Overview

This repository maintains bilingual user documentation under docs/. docs/en/ and docs/zh/ are mirrored pairs for most pages; update both in the same change. Changelog is the exception, English is the source, and Chinese is translated from English.

Use this skill to update the corresponding documentation whenever the codebase has changes that affect product behavior or user experience.

For a full pre-release audit of all pages (detecting hallucinations and coverage gaps), use the audit-docs skill instead.

Prerequisites

This skill depends on the following being in place. If any are missing, stop and report to the user before continuing:

• docs/ directory with docs/zh/, docs/en/, and docs/.vitepress/config.ts set up (VitePress site).
• docs/AGENTS.md style guide, defines source-of-truth rules, terminology table, typography, and writing style.
• docs/scripts/sync-changelog.mjs, auto-syncs root CHANGELOG.md to docs/en/release-notes/changelog.md.
• translate-docs skill in .agents/skills/, handles bilingual synchronization.

Workflow

1. Inspect changes

   • git log main..HEAD --oneline, commits on the current branch
   • git diff main..HEAD --stat, file-level scope
   • ls .changeset/*.md (excluding README.md), pending changeset entries
   • Read CHANGELOG.md and any subpackage packages/*/CHANGELOG.md for already-recorded entries.

2. Understand user-facing impact

   For each change, read the actual implementation when needed; do not infer behavior from commit messages or PR titles alone. Skip:

   • Internal refactors with no externally visible behavior change
   • Tests, CI, type-only changes
   • Tooling / build-system changes that do not change how users invoke the CLI

   If after the scan you conclude there is no user-facing impact, say so and stop.

3. Sync English changelog

   Run:

   node docs/scripts/sync-changelog.mjs