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.
Installation
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
View source ↗GuidesSkill instructions
Features and purpose
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.
Quick start
Follow the repository instructions for this skill and your agent. Review the files and dependencies before adding it to your workflow.
Guides ↗Examples
Read the usage examples in the source repository.
View source ↗Source history
- Indexed on
- 2026-01-20
- Index updated
- 2026-01-26
- Branch
- main
Index and sync dates describe this directory. View the source repository for code history.
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!