project-docs

Write and maintain the MkDocs documentation site including pages, nav, diagrams, and icons.

49|11|Updated Jul 31, 2026
One-click install
npx skills add https://github.com/vstorm-co/agenticos --skill project-docs-vstorm-co
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-docs
Source: https://github.com/vstorm-co/agenticos/tree/main/.claude/skills/project-docs
Command: npx skills add https://github.com/vstorm-co/agenticos --skill project-docs-vstorm-co

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Keeping a documentation site accurate after code changes is hard: pages drift from behaviour, dead links slip into CI, and Mermaid diagrams or icons silently render broken. This Skill encodes the project's docs conventions so edits to docs/ and mkdocs.yml stay consistent and pass the strict build. ## Core Features & Use Cases - Page authoring and nav wiring: Add a page in docs/, place it in the mkdocs.yml nav at the right position, and cross-link it from CLAUDE.md's topic table. - Rendering pitfall prevention: Covers the three known silent failures — Mermaid needing custom_fences, icons needing pymdownx.emoji, and --strict not validating anchors. - mkdocstrings constraints: Explains that the static collector cannot traverse app/services/, app/api/, or app/worker/ (no init.py), so those must be referenced from prose with source links. - Use Case: After changing how a budget check behaves, update the docstring that generates the API reference, fix the affected prose page, run make docs-build, and verify anchors before CI fails. ## Quick Start Update the docs page describing the feature I just changed, wire any new page into the mkdocs.yml nav, and run make docs-build to confirm the strict build passes.

Frequently Asked Questions about project-docs

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

FAQPage Schema
How do I add a new page to a MkDocs Material site?▼

Write the Markdown file in docs/, then add it to the nav in mkdocs.yml at the position it belongs — a page outside the nav is a build warning under --strict. Cross-link it from pages readers arrive from, run make docs-build, and check anchors.

Why is my Mermaid diagram not rendering in MkDocs Material?▼

Mermaid needs custom_fences configured on pymdownx.superfences, otherwise the block goes to the syntax highlighter and readers see raw source. Material renders into a closed shadow root, so verify with a screenshot rather than querySelector.

Does mkdocs build --strict catch broken anchor links?▼

No, --strict does not validate anchors. A #fragment matching no heading passes the build, so fragments must be checked by hand or with a script over the rendered headings.

Why does mkdocstrings fail on packages without __init__.py?▼

The mkdocstrings collector is static and cannot traverse directories lacking __init__.py, so ::: app.services.foo fails the build. Reference those modules from prose with a source link until the packages are made explicit.

How do I link to an excluded file in MkDocs without failing the build?▼

A published page linking to a file in exclude_docs fails --strict because the excluded file is never built. Link it by GitHub blob URL instead, as done for ROADMAP.md and design.md.