documentation-update

Installation
SKILL.md

Documentation Update

Workflow

  1. Identify user-facing changes and which docs are affected (README, docs/, API refs, config/CLI tables).
  2. Locate the docs toolchain (Sphinx/MkDocs/Docusaurus/TypeDoc/rustdoc/godoc/etc.).
  3. Update docs content + examples to match current behavior (names, flags, defaults, outputs).
  4. Validate by running the repo's docs build/lint/link checks.
  5. Quality pass: consistency, accuracy, and "copy/paste runnable" examples.
  6. 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).
Installs
3
GitHub Stars
2
First Seen
Mar 19, 2026
documentation-update — kittne/codex-skills-by-codex