skills.rest
Chensihakniroth
ChensihaknirothCOMMUNITY
Explore all skills by this author →
GitHub

code-wiki

Generate wiki documentation and Mermaid diagrams for any codebase.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Onboarding to an unfamiliar codebase or producing reference documentation 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, without external services. ## Core Features & Use Cases - Full Wiki Generation: Produces README overview, architecture.md, getting-started.md, per-module docs, and an optional API reference. - Mermaid Diagrams: Creates flowchart, class, and sequence diagrams that render natively on GitHub. - Bounded Scope Control: Caps module count and read depth to keep token costs predictable on large repos, with incremental re-run support via a state file. - Use Case: Point it at a private GitHub repository you just inherited; it clones the repo, scans the structure, and writes a complete wiki to ~/.anakot/wikis/<repo-name>/ with architecture and sequence diagrams. ## 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?▼

Run the code-wiki skill against a local path or GitHub URL. It scans the repository structure, selects 8-10 key modules, and writes a wiki with overview, architecture, per-module docs, and Mermaid diagrams to ~/.anakot/wikis/<repo-name>/.

How to create Mermaid architecture diagrams from source code?▼

The skill reads entry points and core files, then writes Mermaid flowchart, classDiagram, and sequenceDiagram blocks into markdown files. These render natively on GitHub without any plugins or external rendering services.

Does codebase documentation generation work with private repositories?▼

Yes. The skill clones any accessible Git URL with git clone --depth 50 into a temp directory, or works directly on local paths. It uses only terminal and file tools, so no external services or Docker are required.

What languages are supported for automatic code documentation?▼

Any language is supported. The skill applies per-language heuristics for module selection, covering Python packages, JS/TS src directories, Rust crates, and Go packages, with a generic fallback for mixed or unfamiliar stacks.

When should I not use automated wiki generation for a repo?▼

Skip it for single-file or single-function questions, one-off API lookups, or codebases you are actively editing in the session. It is designed for stable reference documentation, not inline answers or strategic narrative.

How do I update generated wiki docs after code changes?▼

The skill writes a .codewiki-state.json file recording the source SHA. On re-run, it compares SHAs and can regenerate only modules affected by changed files identified via git diff.

Related Skills

Explore More Software Engineering Skills→
nholder88nholder88
2

draft-repo-readme

Draft a README from a repository's source files and commit history.

Community
Intermediate
dhaneshdhanesh
1

okf-site-kit

Generate a browsable Astro and Starlight static website from an OKF knowledge bundle.

Community
Advanced
k97k97
4

typescript-circular-dependency

Identify and resolve circular module dependencies in TypeScript and JavaScript codebases.

Community
Intermediate
astralform-aiastralform-ai

deepwiki

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

Official
Basic