generating-codebase-wiki

Installation
SKILL.md

Generate a DeepWiki-style codebase wiki

Produce a self-contained static HTML site that a new engineer can browse like DeepWiki. Match that bar: architecture first, every claim grounded in real files/symbols, diagrams whose nodes are code entities.

Inputs

  • Repo root (required): absolute path to a git checkout
  • Output dir (optional): default <repo>/wiki-site/
  • Language: Japanese if the repo's product UI / CLAUDE.md is Japanese; else English. Do not mix.

Mandatory reads (this order)

  1. references/quality-bar.md — what "as good as DeepWiki" means
  2. references/research-protocol.md — archaeology before any HTML
  3. references/page-anatomy.md — page chrome, citations, mermaid
  4. references/cite-write.md — write-time cite recipe (one sentence → one cite; mermaid labels are citations)
  5. Copy assets/wiki.css and assets/wiki.js into the output dir unchanged
  6. Use assets/page.template.html for every page
  7. Before claiming done, score the site against references/review-rubric.md. Fix until every gate is Pass. verify-cites.mjs must print CITE_FILES_OK with zero ILLEGAL_FIRST / MERMAID_TOKEN_MISSING / MERMAID_EXTRA_ZERO_TOKEN / FIGURE_NO_SOURCES / OVERVIEW_NO_ENTITY_TABLE / UNUSED_CHIP / CITE_UNDEFINED / OOB / MISSING / MERMAID_HELPER_FIRST / SENTENCE_TOKEN_MISSING / SIBLING_FIRST / FACTORY_ON_CALLER / MERMAID_FACTORY_CALLER / OVERVIEW_TABLE_SOURCES_DUMP / INNER_SUBJECT / SLICE_PROPERTY / OBJECT_KEY / GLOSSARY_NO_DL / GLOSSARY_THIN_DL / GLOSSARY_P_CITE / GLOSSARY_STUB_DT / OVERVIEW_ENTITY_ORPHAN / DOTTED_CALLEE / GLOSSARY_UNPAIRED / CALL_ON_ENCLOSING
Installs
2
GitHub Stars
1
First Seen
Sep 21, 2026