AGENT SKILL

code-wiki

Generate wiki docs + Mermaid diagrams for any codebase.

License 许可
MIT
最近更新
2026-11-13
Stars
★ 0
Forks
0

01 前言 Front Matter

name
code-wiki
author
Teknium (teknium1), Hermes Agent, ported for CrusorAI
license
MIT
version
0.2.0
metadata
{ "hermes": { "tags": [ "documentation", "mermaid", "architecture", "diagrams", "wiki", "code-analysis", "onboarding" ], "related_skills": [ "codebase-inspection", "codebase-map" ] } }
platforms
[ "linux", "macos", "windows" ]
description
Generate wiki docs + Mermaid diagrams for any codebase.

03 SKILL.md 正文

Triggers: wiki, document this codebase, architecture diagram, mermaid, generate docs, codebase documentation, onboarding docs, explain the architecture

Code Wiki

Generate a wiki for any codebase — overview, architecture, per-module deep-dives, Mermaid class and sequence diagrams. Uses only existing Crusor tools (run_terminal, read_file, search_files, write_file); no Docker, no external services, no extra dependencies.

Produces reference documentation (what/how) — not strategic narrative (why), not single-function explanations (just answer inline).

When to Use

  • "Document this codebase", "generate a wiki", "make architecture diagrams"
  • Onboarding to an unfamiliar repo as structured reference
  • A stable markdown+Mermaid artifact is wanted that renders on GitHub

Do NOT use for: single-file/function docs (answer directly), repos the user is actively reshaping this session (answer as questions come).

Quick Reference

Step Action
1 Resolve target — workspace root, given path, or git clone --depth 50 <url> to a temp dir
2 Scan structure — ls, find -maxdepth 3, manifest files, README
3 Pick 8–10 modules to document
4 Write README.md (overview + module map)
5 Write architecture.md with Mermaid flowchart
6 Write per-module docs in modules/
7 Write diagrams/class-diagram.md (Mermaid classDiagram)
8 Write diagrams/sequences.md (2–4 key workflow sequenceDiagrams)
9 Write getting-started.md (+ api.md if applicable)
10 Report paths to the user

Default output: ~/.crusorai/wikis/<repo-name>/. Write INTO the repo (docs/wiki/) only when the user explicitly requests it.

Procedure

REPO_SHA=$(git rev-parse HEAD 2>/dev/null || echo "uncommitted")
OUTPUT_DIR="$HOME/.crusorai/wikis/$(basename $PWD)"
mkdir -p "$OUTPUT_DIR/modules" "$OUTPUT_DIR/diagrams"

Scan with run_terminal (find . -maxdepth 3 -type f | grep -v node_modules | head -80), read READMEs and entrypoints with read_file, map structure with search_files. Record the commit SHA in the wiki header — docs rot, the SHA dates them.

Quality Bars

  • Modules are mental units (runtime, bridge, ui), not folder dumps; say what each module is FOR in one sentence before any detail.
  • Mermaid diagrams must render: keep node labels quoted, no raw --> inside labels, one diagram per concern. If a diagram is >15 nodes, split it.
  • Sequence diagrams follow REAL call paths you verified in code — file:line references in the doc body, not in the diagram.
  • Every claim about behavior cites a file you actually read this session.
  • Prefer tables for inventories (endpoints, commands, config keys); prose only for relationships.

Invariants

  • Never modify source code while generating a wiki (read-only task, write_file only into the output dir).
  • One session = one repo; if the target changes, restart the wiki.
  • Report output paths at the end; offer getting-started.md as the entry point.

04 同仓库更多 Skills

SriAkhilSJ
SriAkhilSJ/PulseAIRepo

interaction-patterns-architect

Architect-level interaction design in code — choosing established patterns over invented ones, feedback and latency behaviour, destructive-action safeguards, navigation and overlay conventions, and the state model behind every interactive surface. Use when a screen has to behave, not just look.

★ 0
SriAkhilSJ
SriAkhilSJ/PulseAIRepo

design-system-ops-architect

Architect-level operation of a design system in code — token pipelines and versioning, component API and variant policy, the catalogue as the contract, adoption metrics, and the governance that stops a system from forking into three. Use when a component library must survive several teams.

★ 0
SriAkhilSJ
SriAkhilSJ/PulseAIRepo

design-handoff-architect

Architect-level design handoff — what must be specified before implementation starts, tokens over raw values, responsive and content-limit contracts, state matrices, and the review loop that catches drift between design and code. Use when a design is about to become code.

★ 0
SriAkhilSJ
SriAkhilSJ/PulseAIRepo

content-microcopy-architect

Architect-level UI content — where strings live, voice and terminology consistency, error and empty-state copy as part of the interface, translation-ready authoring, and the content model a product needs before it multiplies screens. Use when the words in the interface matter as much as the pixels.

★ 0
SriAkhilSJ
SriAkhilSJ/PulseAIRepo

ui-ux-implementation-architect

Architect-level direction for turning a design into working UI — the handoff contract, component ownership versus screen-level layout, interaction and state conventions, design QA gates, and the review habits that keep an implementation faithful without frozen pixels. Use before any specific UI implementation skill.

★ 0
SriAkhilSJ
SriAkhilSJ/PulseAIRepo

test-strategy-architect

Architect-level test strategy — allocating assertions across unit, integration, contract and end-to-end layers, designing for testability through dependency boundaries, fixture and data strategy, and the flake and coverage policies that keep a suite trustworthy. Use when defining how a codebase is tested.

★ 0