skills.rest
sharosoo
sharosooCOMMUNITY
Explore all skills by this author →
GitHub

wiki

Generate wiki-style codebase documentation with evidence citations and Mermaid diagram validation.

Updated Jul 31, 2024
Search Tags:#documentation#mermaid#codebase#citations#wiki#incremental sync#toc
One-click install
npx skills add https://github.com/sharosoo/dotfile --skill wiki-sharosoo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: wiki
Source: https://github.com/sharosoo/dotfile/tree/main/.claude/skills/wiki
Command: npx skills add https://github.com/sharosoo/dotfile --skill wiki-sharosoo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and references (resource) components.

What problem does it solve? Keeping codebase documentation accurate and up to date is tedious: wikis drift out of sync with source code, and manually writing architecture overviews for unfamiliar projects takes hours. This Skill automates the full lifecycle of wiki documentation, from repository scanning to incremental updates after code changes. ## Core Features & Use Cases - Multi-phase documentation pipeline: Scan the repository, design a TOC (toc.yaml), generate pages with evidence-based source citations, validate Mermaid diagrams and structure, and produce a SUMMARY.md report. - Incremental sync: Detect git changes since the last documented commit and regenerate only affected AUTOGEN sections, preserving manually written content outside markers. - Parallel page generation: When subagents are supported, spawn one workflow-runner subagent per page to speed up the doc-write phase. - Use Case: After merging a large feature branch, run the incremental mode to update only the wiki sections whose source files changed, then review the generated SUMMARY.md for coverage gaps. ## Quick Start Ask the AI to generate comprehensive wiki documentation for this repository using the wiki skill.

Frequently Asked Questions about wiki

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

FAQPage Schema
How do I generate wiki documentation for a codebase automatically?▼

Run the wiki skill in Automatic mode, which executes five phases: repo-scan, toc-design, doc-write, validate-docs, and doc-summary. It scans the repository structure, designs a toc.yaml, generates cited pages, and outputs a SUMMARY.md report.

How to update documentation after code changes without regenerating everything?▼

Use Incremental mode, which runs collect_update_context.py to diff the last documented commit against HEAD. Only AUTOGEN sections whose source files changed are regenerated, while manually written content outside the markers is preserved.

Can I generate only a documentation table of contents without full pages?▼

Yes, Structure-only mode runs just the repo-scan and toc-design phases and stops before writing pages. TOC-based mode does the reverse, generating pages from an existing toc.yaml file.

Does the wiki generator support languages other than English?▼

Yes, output language is controlled by a locale code passed to the workflow or read from the TOC project.language field. The default in the evidence policy is ja-JP, and all generated content follows the specified locale.

What are the limitations of incremental documentation updates?▼

Incremental mode requires a valid ref_commit_hash in the TOC; without it the skill falls back to full generation. New source files not covered by TOC glob patterns may require manual TOC edits, and CI/CD or config files are intentionally excluded from new pages.

Related Skills

Explore More Software Engineering Skills→
kagentikagenti
292

onboard:link

Clone Git repositories into the Kagenti hub and verify skill discoverability.

Official
Basic
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
Ramprasad4121Ramprasad4121
1

audit-prep-assistant

Prepare codebases for security review with static analysis and documentation.

Community
Advanced
gao-hongnangao-hongnan
3

docstrings

Enforce NumPy-style Python docstrings compatible with Sphinx Napoleon.

Community
Intermediate