maintain-docs

What problem does it solve?

The Maintain Docs skill automates documentation management for code changes using a progressive disclosure framework, helping teams keep a stable main guide while evolving detailed reference material.

Core Features & Use Cases

• Progressive disclosure framework: maintains a stable main documentation file (AGENTS.md) and a set of evolving reference docs.
• Pre-commit documentation checks: guides agents to assess whether changes belong in the main doc or a reference doc, and to create/update docs accordingly.
• Automated reference doc lifecycle: creates new reference docs from a template, and updates the Reference Documentation table to keep mappings current.

Quick Start

1. Review the skill purpose and structure.
2. Run assess_doc_change.py "<description of change>" to determine where documentation should go.
3. If a new reference doc is needed, run python scripts/create_reference_doc.py <topic> "<when-to-read>" to generate it.
4. Update the Reference Documentation table with python scripts/update_reference_table.py <filename> "<when-to-read>".
5. Run npm run lint to validate documentation and tooling setup.