skills.rest
loteiron
loteironCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

code-wiki

Generate wiki documentation and Mermaid diagrams for any codebase.

Updated Sep 10, 2026
Search Tags:#architecture#documentation#onboarding#mermaid#codebase#wiki#diagrams
One-click install
npx skills add https://github.com/loteiron/ZeusAgent --skill code-wiki-loteiron
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-wiki
Source: https://github.com/loteiron/ZeusAgent/tree/main/optional-skills/software-development/code-wiki
Command: npx skills add https://github.com/loteiron/ZeusAgent --skill code-wiki-loteiron

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Onboarding to an unfamiliar repository or documenting a codebase manually is slow and error-prone. This Skill automates the creation of a structured wiki — overview, architecture, per-module deep-dives, and Mermaid diagrams — for any local or remote repository, in any language, using only built-in file and terminal tools. ## Core Features & Use Cases - Full Wiki Generation: Produces README overview, architecture.md with Mermaid flowcharts, per-module docs, class and sequence diagrams, getting-started guides, and optional API references. - Local and Remote Repos: Works on the current directory, a given path, or a GitHub URL cloned shallowly to a temp directory, with commit-SHA tracking for re-runs. - Bounded Scope Control: Caps module coverage, filters vendored and generated code, and verifies Mermaid blocks and file outputs to prevent fabrication. - Use Case: Point the agent at a private repo you just inherited and receive a complete wiki at ~/.zeus/wikis/<repo-name>/ with architecture diagrams and module references that render on GitHub. ## Quick Start Ask the agent to generate a wiki with architecture diagrams for the repository at the current path or a given GitHub URL.

Frequently Asked Questions about code-wiki

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for an entire codebase automatically?▼

Invoke the skill from the target repo root or provide a GitHub URL. It scans the structure, selects 8-10 key modules, and writes a wiki with overview, architecture, per-module docs, and Mermaid diagrams to ~/.zeus/wikis/<repo-name>/.

How to create Mermaid architecture and sequence diagrams from source code?▼

The skill reads entry points and key files, traces real call paths, then writes Mermaid flowchart, classDiagram, and sequenceDiagram blocks. Every diagram node must correspond to an actual component found in the source to avoid fabrication.

Does codebase wiki generation work with private or local repositories?▼

Yes. It works on the current working directory, any local path, or a GitHub URL cloned with git clone --depth 50 to a temp directory. No Docker, external services, or extra dependencies are required.

What languages are supported for automatic code documentation?▼

Any language is supported. Module-selection heuristics cover Python packages, JS/TS src directories, Rust crates, and Go packages, with a fallback to top-level source directories for mixed or unfamiliar stacks.

What are the limitations of auto-generated codebase wikis?▼

Large monorepos are token-expensive, so scope is bounded: depth-3 scans, a 10-module cap, and skipped vendored or generated code. It produces reference documentation (what/how), not strategic why-narrative, and full incremental regeneration is not yet implemented.

Related Skills

Explore More Software Engineering Skills→
igniteenowigniteenow
16

code-wiki

Generate wiki documentation and Mermaid diagrams for any codebase.

Community
Advanced
jeff-hammjeff-hamm

new-team

Clone Git repos and crawl Confluence spaces into a structured local workspace.

Community
Advanced
rh-ai-quickstartrh-ai-quickstart
9

Project Status Check

Run lint, type checks, tests, and dependency audits to produce a health dashboard.

Official
Intermediate
HomericIntelligenceHomericIntelligence
18

generate-api-docs

Generates API reference documentation from Python docstrings using pdoc or Sphinx.

Official
Intermediate