doc

Generate and update mdBook documentation pages from specs and Rust source code.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/pcortellezzi/rs_trader --skill doc-pcortellezzi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc
Source: https://github.com/pcortellezzi/rs_trader/tree/main/.claude/skills/doc
Command: npx skills add https://github.com/pcortellezzi/rs_trader --skill doc-pcortellezzi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates manual, error-prone documentation maintenance by reading specification files and source code to generate or update user and developer documentation, detect missing pages, and verify the documentation build.

Core Features & Use Cases

  • Documentation coverage audit: scans docs/SUMMARY.md and reports missing or empty pages and overall coverage.
  • Spec-driven page generation: creates user-friendly pages from specs and technical developer pages from code and crate-level details.
  • Summary and build verification: updates SUMMARY.md when new pages are created and runs mdbook build to catch broken links or formatting errors.
  • Use case: regenerate the dev architecture and chart-related user pages after interface changes to ensure published docs match the implemented code.

Quick Start

Run the doc skill with the argument user to regenerate all user guide pages and then run mdbook build to verify there are no broken links.

Frequently Asked Questions about doc

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

FAQPage Schema
How do I automate documentation generation from Rust source code and specs?

Automate documentation by reading project specs and Rust source code to generate or update user guides and developer reference pages, then validating the output by running mdbook build to catch broken links and formatting errors.

What is the best way to audit mdBook documentation coverage for missing pages?

Audit mdBook documentation coverage by scanning docs/SUMMARY.md to report missing or empty pages and calculate overall documentation completeness for your Rust project.

Can I use this to generate user guides from specs for an mdBook workflow?

Yes, you can generate user-friendly documentation pages from project specs and technical developer pages from Rust code, modify docs/SUMMARY.md as needed, and validate the build with mdbook build.

Do I need mdBook to validate the documentation generated from my Rust codebase?

Yes, mdBook is required to validate generated documentation, as the workflow runs mdbook build to catch broken links and formatting errors after creating or updating markdown pages.

How do I update docs/SUMMARY.md when adding new documentation pages?

Update docs/SUMMARY.md automatically when new documentation pages are created from specs and code, ensuring the mdBook table of contents stays synchronized with generated markdown files.