skills.rest
xiaolai
xiaolaiCOMMUNITY
Explore all skills by this author →
Website𝕏@xiaolaiGitHub

mapping

Resolve source-to-documentation mappings across MkDocs, VitePress, Docusaurus, and Sphinx.

6|Updated Feb 28, 2026
Search Tags:#documentation#frameworks#audit#config#conventions#mapping#code-to-doc
One-click install
npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill mapping-xiaolai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: mapping
Source: https://github.com/xiaolai/docs-guardian-for-claude/tree/main/skills/docs-guardian/mapping
Command: npx skills add https://github.com/xiaolai/docs-guardian-for-claude --skill mapping-xiaolai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Strategies for mapping source code files to their corresponding documentation files, enabling accurate traceability and gap analysis across multiple documentation frameworks.

Core Features & Use Cases

  • Config-Based mappings: User-defined mappings in .claude/docs-guardian/config.json to bind sources to docs.
  • Framework-Derived mappings: Leverage framework configurations (MkDocs, VitePress, Docusaurus, Sphinx) to infer doc paths from navigation or sidebars.
  • Convention-Based mappings: Fall back to naming conventions to pair common sources with docs and surface unmapped sources.

Quick Start

Configure mappings in .claude/docs-guardian/config.json and run a mapping pass to generate the resolved source-to-doc associations.

Frequently Asked Questions about mapping

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

FAQPage Schema
How do I map source code files to their corresponding documentation files?▼

You can map source code files to documentation automatically using config-based, framework-derived, convention-based, and inline-doc strategies to generate mapping entries with source, doc, strategy, and confidence fields.

How does code-to-doc mapping work with documentation frameworks like VitePress or Docusaurus?▼

Framework-derived mapping leverages configurations from VitePress, Docusaurus, MkDocs, or Sphinx to infer documentation paths directly from navigation or sidebar definitions.

How do I define custom source-to-doc mappings for my project?▼

Define custom source-to-doc mappings by adding user-defined bindings in the .claude/docs-guardian/config.json file to explicitly bind specific source files to their corresponding documentation.

Can I identify documentation gaps for unmapped source files?▼

Yes, the mapping process surfaces unmapped sources as potential gaps, outputting a list of resolved source-to-doc associations alongside notes on any sources lacking corresponding documentation.

What is the best way to handle code-to-doc traceability across plain Markdown projects?▼

For plain Markdown projects, code-to-doc traceability falls back to convention-based mappings that pair common source files with documentation files using standard naming conventions.

Related Skills

Explore More Software Engineering Skills→
hidemaro-nsketchhidemaro-nsketch

context-loader

Load project context from the .claude directory for OpenCLI.

Community
Intermediate
sunholo-datasunholo-data
33

Test Coverage Guardian

Analyze test coverage to identify gaps, dead code, and brittleness.

Community
Intermediate
jinwoonghongjinwoonghong

moai-docs-generation

Generate technical documentation from source code and Markdown using Sphinx, MkDocs, and Docusaurus.

Community
Advanced
tomique34tomique34
8

api-docs-generator

Generate Markdown API documentation from OpenAPI specs, Python docstrings, and JSDoc/TSDoc comments.

Community
Advanced