Code Wiki — Generate wiki docs + Mermaid diagrams for any codebase
Code Wiki — Generate wiki docs + Mermaid diagrams for any codebase
Start with meaning, then move to detail.
This lesson explains Code Wiki — Generate wiki docs + Mermaid diagrams for any codebase as part of extending Hermes and connecting external tools. You will learn what it does, when it matters, and the smallest safe test that proves it works.
If you are new, do not memorize names. Focus on three questions: what problem does this solve, what access does it need, and how can you verify the result?
For practice, inspect the first example, identify its effects, run it on test data, and compare the result with the source claim.
For advanced readers, inspect Skill metadata, Reference: full SKILL.md, When to Use, then verify failure modes and version compatibility.
Complete installation and one successful task before adding new capabilities.
A clear outcome before you read.
- Understand Code Wiki — Generate wiki docs + Mermaid diagrams for any codebase without assumed prior knowledge.
- Separate the source description from what still needs testing in your environment.
- Read the first command and identify its inputs and outputs before copying it.
Short definitions before the details.
- Skill
- An instruction bundle that teaches Hermes a repeatable workflow without necessarily adding an external service.
Generate wiki docs + Mermaid diagrams for any codebase
What does the source say, and in what order?
- 01Skill metadata
Start here to understand the core idea or structure.
- 02Reference: full SKILL.md
Read this after the foundation, then connect it to the previous step.
- 03When to Use
Read this after the foundation, then connect it to the previous step.
- 04Prerequisites
Read this after the foundation, then connect it to the previous step.
- 05How to Run
Read this after the foundation, then connect it to the previous step.
- 06Quick Reference
Read this after the foundation, then connect it to the previous step.
- 07Procedure
Read this after the foundation, then connect it to the previous step.
- 081. Resolve the target
Read this after the foundation, then connect it to the previous step.
- 092. Scan repo structure
Read this after the foundation, then connect it to the previous step.
- 103. Pick modules to document
Finish here to verify the result and special cases.
Copy only after you understand the effect.
WIKI_TMP=$(mktemp -d)
git clone --depth 50 <url> "$WIKI_TMP/repo"
cd "$WIKI_TMP/repo"
REPO_SHA=$(git rev-parse HEAD)
REPO_NAME=$(basename <url> .git)cd <path>
REPO_SHA=$(git rev-parse HEAD 2>/dev/null || echo "uncommitted")
REPO_NAME=$(basename "$PWD")OUTPUT_DIR="$HOME/.hermes/wikis/$REPO_NAME"
mkdir -p "$OUTPUT_DIR/modules" "$OUTPUT_DIR/diagrams"Read the first command and identify its inputs and outputs before copying it.
Match every command to your installed Hermes version, review the files and accounts it can reach, and use non-sensitive data for the first test. If this explanation differs from the source, the official source wins.