Generate citation-backed documentation pages from code index. Creates markdown content with file path and line number citations for every technical claim.
Repo Wiki Generate Pages Skill
Generate citation-backed markdown documentation from the code index.
Purpose
This skill transforms the code index into comprehensive documentation pages with:
- Technical accuracy backed by source code citations
- File paths and exact line ranges for every claim
- Clickable permalinks to source code
- Structured markdown with managed blocks
When to Use
Use this skill:
- After running
repo-wiki-index - To fill in placeholder pages with actual content
- When generating documentation for the first time
Step-by-Step Instructions
Step 1: Load Index and Configuration
Load .repo_wiki/code_index.json and .repo_wiki/state.json.
Step 2: Determine Citation Format
Choose between footnote or inline style based on config.
Step 3: Generate Component Pages
For each component, create documentation with:
- Overview and purpose
- Key files with citations
- Public interfaces
- Configuration options
Step 4: Generate Architecture Overview
Create system-level documentation with statistics and component relationships.
Step 5: Generate Getting Started Pages
Document setup, installation, and running instructions.
Step 6: Update Manifest
Track all citations in .repo_wiki/manifest.json.
Citation Format
The service starts an HTTP server[^1].
[^1]: [src/server.ts#L12-L48](https://github.com/org/repo/blob/abc1234/src/server.ts#L12-L48)
Success Criteria
- ✅ All component pages have content
- ✅ Every technical claim has a citation
- ✅ Citations include file paths and line ranges
- ✅ MkDocs builds without errors
Next Steps
After generation:
- Validate output: Read
repo-wiki-validate/SKILL.md
You Might Also Like
Related Skills
update-docs
This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with code", "scaffold docs for this feature", "document this feature", "review docs completeness", "add docs for this change", "what documentation is affected", "docs impact", or mentions "docs/", "docs/01-app", "docs/02-pages", "MDX", "documentation update", "API reference", ".mdx files". Provides guided workflow for updating Next.js documentation based on code changes.
vercel
docstring
Write docstrings for PyTorch functions and methods following PyTorch conventions. Use when writing or updating docstrings in PyTorch code.
pytorch
docs-writer
Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.
google-gemini
write-concept
Write or review JavaScript concept documentation pages for the 33 JavaScript Concepts project, following strict structure and quality guidelines
leonardomsoresource-curator
Find, evaluate, and maintain high-quality external resources for JavaScript concept documentation, including auditing for broken and outdated links
leonardomso
doc-coauthoring
Guide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.
anthropics