skills.rest
vivekgoquest
vivekgoquestCOMMUNITY
Explore all skills by this author →
GitHub

code-wiki

Generate wiki documentation and Mermaid diagrams for any codebase.

Updated Aug 22, 2026
Search Tags:#architecture#code analysis#markdown#onboarding#mermaid diagrams#codebase documentation#wiki generation
One-click install
npx skills add https://github.com/vivekgoquest/hermes-agent-stable --skill code-wiki-vivekgoquest
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-wiki
Source: https://github.com/vivekgoquest/hermes-agent-stable/tree/main/optional-skills/software-development/code-wiki
Command: npx skills add https://github.com/vivekgoquest/hermes-agent-stable --skill code-wiki-vivekgoquest

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Onboarding to an unfamiliar repository or documenting an undocumented codebase requires hours of manual reading and writing. This Skill automates the creation of a structured wiki — overview, architecture, per-module deep-dives, and Mermaid diagrams — for any local or remote repository. ## Core Features & Use Cases - Full Wiki Generation: Produces README overview, architecture.md, getting-started.md, per-module docs, and an optional API reference, all in GitHub-renderable Markdown. - Mermaid Diagrams: Creates flowchart, class, and sequence diagrams grounded in the actual source code, with shape semantics for components, databases, and external services. - Bounded Scope Control: Caps module count and read depth to keep token costs predictable on large repos, with state tracking via .codewiki-state.json for re-runs. - Use Case: Point it at a GitHub URL for a project you just inherited; it clones the repo, scans the structure, picks the 8–10 most important modules, and writes a complete wiki to ~/.hermes/wikis/<repo-name>/. ## Quick Start Ask the agent to generate a wiki with architecture diagrams for the repository at a given path or 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?▼

Point the skill at a local path or GitHub URL; it scans the repository structure, selects 8–10 key modules, and writes a full wiki with overview, architecture, per-module docs, and Mermaid diagrams to ~/.hermes/wikis/<repo-name>/.

How to create Mermaid architecture diagrams from source code?▼

The skill reads entry points and core files, traces call paths, then writes flowchart, classDiagram, and sequenceDiagram blocks using shape semantics for components, databases, and external services. Every diagram node is verified against real source files.

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

Yes, it works on any local directory or cloned repo in any language, using only terminal, read_file, search_files, and write_file tools. No Docker, external services, or extra dependencies are required beyond git.

Can I regenerate wiki docs after the code changes?▼

The skill writes a .codewiki-state.json tracking the source SHA and documented modules. On re-run it compares SHAs and can regenerate everything or focus on modules with changed files via git diff.

What are the limitations of automated codebase documentation?▼

It is token-expensive on very large monorepos, so scope is bounded to depth-3 scans and 10 modules by default. It also skips vendored, generated, and test code, and does not produce strategic narrative about why the project exists.

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
samuelbonifacio015samuelbonifacio015

codebase-inspection

Automate codebase inspection with pygount for LOC, language breakdown, and code-to-comment ratios.

Community
Intermediate
astralform-aiastralform-ai

deepwiki

Query AI-generated documentation for public GitHub repositories via the DeepWiki MCP service.

Official
Basic