docs-align

Installation
SKILL.md

Docs Align

Use this skill after implementation work or when you suspect documentation drift.

Workflow

  1. Read the repo AGENTS.md.
  2. From this skill root (directory containing SKILL.md), run drift collection (requires git on PATH):
    • python3 scripts/docs_drift.py collect --cwd <repo> --out <json>
    • Equivalent collect-only shortcut: python3 scripts/check_docs_drift.py --cwd <repo> --out <json>
  3. python3 scripts/docs_drift.py compare --input <json> --out <json>
  4. Render the summary:
    • python3 scripts/docs_drift.py render --input <json> --format md
  5. Use Alignment policies below only for doc surfaces that the gap map says are in scope.
  6. Update docs only after the gap map is clear.

Path note

Commands above assume the current working directory is this skill’s root (skills/docs-align in this repository). If the working directory is elsewhere, invoke the same files with an absolute path, for example:

Related skills

More from bjornmelin/dev-skills

Installs
1
GitHub Stars
2
First Seen
2 days ago