skills.rest
k2works
k2worksCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

operating-docs

Generate document inventories and progress reports for MkDocs repositories.

Updated Apr 10, 2026
Search Tags:#documentation#markdown#indexing#docs#lint#mkdocs#progress-tracking
One-click install
npx skills add https://github.com/k2works/getting-started-algorithm --skill operating-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: operating-docs
Source: https://github.com/k2works/getting-started-algorithm/tree/main/.agents/skills/operating-docs
Command: npx skills add https://github.com/k2works/getting-started-algorithm --skill operating-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about operating-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep MkDocs navigation in sync with my Markdown documentation files?▼

To keep MkDocs navigation in sync, scan the docs/ directory to automatically update docs/index.md and mkdocs.yml, ensuring the site navigation reflects the current document structure without manual editing.

How do I generate a progress report for project design documents?▼

Generate a progress report by scanning your Markdown design artifacts to produce categorized inventories of requirement documents and compute their completion percentages for quick review.

Can I automatically fix Markdown lint violations in my docs directory?▼

Yes, you can automatically fix Markdown lint violations by running project-specific lint rules across the docs/ directory, applying automated formatting fixes, and reporting the changes made.

What is the best way to inventory design documents for a design review?▼

The best way to inventory design documents is scanning the repository to generate a consolidated list of design artifacts, confirm which items are incomplete, and automatically update the index for reviewers.

Does this documentation maintenance tool work without external dependencies?▼

Yes, this documentation maintenance tool works without external dependencies, operating directly on MkDocs-based repositories and Markdown design artifacts to manage indexes and apply lint autofixes.

Related Skills

Explore More Software Engineering Skills→
kettleofketchupkettleofketchup

mkdocs-documentation

Automate MkDocs Material documentation management with validation and testing.

Community
Intermediate
WtydWtyd
9

docs

Organize GitHooks documentation pages with MkDocs and GitHub Actions deployment.

Community
Intermediate
PelekePeleke

mkdocs-site-generator

Generate MkDocs documentation sites with GitHub Pages CI/CD for TypeScript/Node.js codebases.

Community
Advanced
zzafergokzzafergok
1

markdown-to-html-skill

Convert Markdown documents to HTML using marked.js, pandoc, gomarkdown, or static site generators.

Community
Intermediate