Documentation Maintenance
Use this skill when documentation must match real code, commands, package metadata, generated docs, and site behavior.
Ground Truth
Use implementation, tests, package metadata, CLI output, generated docs, docs scripts, and commit history as ground truth. When documentation depends on external tooling or APIs, verify current primary documentation before changing guidance.
Workflows
Repository Docs
- Inspect docs structure, README, package metadata, docs scripts, examples, generated docs, and site config.
- Fix stale commands, broken links, wrong examples, outdated API descriptions, duplicated sections, and missing setup or usage steps.
- Preserve the repository's voice and structure. Do not invent behavior.
- Validate with docs, link-check, lint, build, or package checks when available.
TSDoc And TypeDoc
- Run or inspect the TypeDoc/docs-validation command.
- Trace referenced symbols before documenting them.
- Describe actual behavior, parameters, type parameters, return values, thrown errors, defaults, examples, deprecations, and links only when useful.
- Use only tags and visibility patterns accepted by the repository's TypeDoc/TSDoc setup.
- Fix pipeline configuration instead of editing generated output when the pipeline is wrong.
Docusaurus Polish
- Inspect Docusaurus config, sidebars, homepage, CSS, docs package metadata, assets, generated docs, search dependencies, and validation scripts.
- Preserve real package identity, route integrity, and generated-doc source-of-truth workflows.
- Improve search, navbar, homepage, footer, sidebars, maintainer paths, and docs organization without inventing fake content.
- Validate docs typecheck/build, lint, tests, and package checks that apply.
Output
Finish with changed docs surfaces, why they changed, validation results, and any unknowns that could not be verified from source.
1---2name: documentation-maintenance3description: Maintains repository docs, TSDoc, TypeDoc output, API comments, and Docusaurus sites. Use when fixing docs drift, TypeDoc diagnostics, TSDoc quality, broken examples/links, or polishing an existing Docusaurus portal.4---56# Documentation Maintenance78Use this skill when documentation must match real code, commands, package metadata, generated docs, and site behavior.910## Ground Truth1112Use implementation, tests, package metadata, CLI output, generated docs, docs scripts, and commit history as ground truth. When documentation depends on external tooling or APIs, verify current primary documentation before changing guidance.1314## Workflows1516### Repository Docs17181. Inspect docs structure, README, package metadata, docs scripts, examples, generated docs, and site config.192. Fix stale commands, broken links, wrong examples, outdated API descriptions, duplicated sections, and missing setup or usage steps.203. Preserve the repository's voice and structure. Do not invent behavior.214. Validate with docs, link-check, lint, build, or package checks when available.2223### TSDoc And TypeDoc24251. Run or inspect the TypeDoc/docs-validation command.262. Trace referenced symbols before documenting them.273. Describe actual behavior, parameters, type parameters, return values, thrown errors, defaults, examples, deprecations, and links only when useful.284. Use only tags and visibility patterns accepted by the repository's TypeDoc/TSDoc setup.295. Fix pipeline configuration instead of editing generated output when the pipeline is wrong.3031### Docusaurus Polish32331. Inspect Docusaurus config, sidebars, homepage, CSS, docs package metadata, assets, generated docs, search dependencies, and validation scripts.342. Preserve real package identity, route integrity, and generated-doc source-of-truth workflows.353. Improve search, navbar, homepage, footer, sidebars, maintainer paths, and docs organization without inventing fake content.364. Validate docs typecheck/build, lint, tests, and package checks that apply.3738## Output3940Finish with changed docs surfaces, why they changed, validation results, and any unknowns that could not be verified from source.
Nick2bad4u