code-wiki

Generate Markdown codebase documentation with Mermaid diagrams.

150|25|Updated Apr 20, 2026
One-click install
npx skills add https://github.com/Devsoul2026/Hermes-One-Click --skill code-wiki-devsoul2026
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: code-wiki
Source: https://github.com/Devsoul2026/Hermes-One-Click/tree/main/hermes-agent/optional-skills/software-development/code-wiki
Command: npx skills add https://github.com/Devsoul2026/Hermes-One-Click --skill code-wiki-devsoul2026

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the creation of comprehensive codebase documentation.

Core Features & Use Cases

  • Generates Markdown wiki with an organized module map and Mermaid diagrams (class and sequence) for quick architectural understanding.
  • Works offline on local repositories and private repos, requiring no external services or dependencies beyond Hermes tooling.
  • Produces artifacts suitable for GitHub rendering, enabling easy onboarding and reference.

Quick Start

Document a target codebase by running the Code Wiki Skill to produce a Markdown wiki plus Mermaid diagrams that you can review and publish.

Frequently Asked Questions about code-wiki

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

FAQPage Schema
How do I auto-generate codebase documentation with architecture diagrams?

To auto-generate codebase documentation, you can use a tool that reads local repository files and produces a Markdown wiki containing an organized module map alongside Mermaid class and sequence diagrams for quick architectural understanding.

Can I generate Mermaid diagrams for a private codebase without external services?

Yes, you can generate Mermaid diagrams for a private codebase without external services by using offline tooling that reads local files directly, requiring no dependencies beyond terminal and file read/write access to compose the documentation.

What's the best way to create a module map for developer onboarding to a new repo?

The best way to create a module map for developer onboarding is to automate wiki generation, producing a referenceable Markdown artifact with structured module maps and visual diagrams suitable for GitHub rendering.

Do I need any external dependencies to create a codebase wiki offline?

No external dependencies are needed to create a codebase wiki offline. The process relies solely on local Hermes tooling, utilizing terminal access and file read/write operations to map the repository and generate Markdown documentation.

Does auto-generated codebase documentation support GitHub rendering for sequence diagrams?

Yes, auto-generated codebase documentation supports GitHub rendering because the output consists of standard Markdown files containing native Mermaid sequence and class diagrams, which GitHub natively renders for repository visualization.

What is the limitation of using automated wiki generation for architecture documentation?

A limitation of automated wiki generation is that the architectural documentation produced is only a static reference artifact, meaning it must be manually re-run or updated to reflect subsequent codebase changes.