documentation-update
Installation
SKILL.md
Documentation Update
Workflow
- Identify user-facing changes and which docs are affected (README,
docs/, API refs, config/CLI tables). - Locate the docs toolchain (Sphinx/MkDocs/Docusaurus/TypeDoc/rustdoc/godoc/etc.).
- Update docs content + examples to match current behavior (names, flags, defaults, outputs).
- Validate by running the repo's docs build/lint/link checks.
- Quality pass: consistency, accuracy, and "copy/paste runnable" examples.
- Summarize what changed, what was verified, and any known gaps.
What to Update
- README and quickstart guides.
docs/pages and tutorials.- API references (OpenAPI/Swagger, SDK docs, typedoc/javadoc/rustdoc/godoc).
- Config and env var reference tables.
- Changelog/release notes (only if the repo uses them).