operating-docs

What problem does it solve?

Provides a unified way to inventory, inspect, and maintain project design documentation so teams can quickly assess completion, read content, and keep documentation indexes and navigation in sync without manual editing.

Core Features & Use Cases

• Inventory & Progress: Scan docs/ to produce categorized lists of requirement and design documents and compute completion percentages.
• Content Access & Review: Read specific Markdown files on demand for quick review and summaries.
• Index & Navigation Sync: Update docs/index.md and mkdocs.yml to reflect the current document structure and ensure MkDocs navigation stays consistent.
• Lint & Autofix: Run project-specific Markdown lint rules and apply automated formatting fixes to enforce documentation style.
• Use Case: When preparing for a design review, generate the current document index, confirm which design artifacts are incomplete, and automatically update the site navigation so reviewers see the correct structure.

Quick Start

Use the operating-docs skill to list all documentation files, show completion status, and update docs/index.md and mkdocs.yml to match the current docs structure.