home/categories/productivity-tools/gavin-qiao-codebase-to-wiki-codebase-to-wiki-skill-md
productivity-toolstools

codebase-to-wiki

Convert arbitrary codebases into structured Obsidian wikis with human-in-the-loop iterative refinement. Use when user asks to analyze, document, or create a wiki for a codebase. Supports three modes: Fresh wiki (plan structure collaboratively), Midway wiki (continue from tracked progress), Debugging (diagnose and fix issues). Features user-defined nested hierarchy, mandatory mermaid graphs and index paragraphs at non-atomic levels, multiple node types (code-bound, code-spanning, conceptual, external), and optional test coverage documentation. DO NOT USE when: code is still under active development, documenting generated/minified code, node_modules/vendor directories, during major refactoring, or when API reference docs (Swagger/TypeDoc) are the actual need.

Gavin-Qiao
maintainer
Gavin-Qiao
Mis à jour 1/15/2026
Étoiles
0
Forks
0
quick start

Installation and usage

Convert arbitrary codebases into structured Obsidian wikis with human-in-the-loop iterative refinement. Use when user asks to analyze, document, or create a wiki for a codebase. Supports three modes: Fresh wiki (plan structure collaboratively), Midway wiki (continue from tracked progress), Debugging (diagnose and fix issues). Features user-defined nested hierarchy, mandatory mermaid graphs and index paragraphs at non-atomic levels, multiple node types (code-bound, code-spanning, conceptual, external), and optional test coverage documentation. DO NOT USE when: code is still under active development, documenting generated/minified code, node_modules/vendor directories, during major refactoring, or when API reference docs (Swagger/TypeDoc) are the actual need.

Installation
$ install --globalskills.sh
Utilisation

Après l'installation, vous pouvez utiliser ce skill en exécutant la commande suivante dans votre terminal :

skills use codebase-to-wiki