Skip to content

feat(skills): add code-wiki skill — closes #486#32240

Merged
teknium1 merged 2 commits into
mainfrom
hermes/hermes-0e17ee5a
May 25, 2026
Merged

feat(skills): add code-wiki skill — closes #486#32240
teknium1 merged 2 commits into
mainfrom
hermes/hermes-0e17ee5a

Conversation

@teknium1

@teknium1 teknium1 commented May 25, 2026

Copy link
Copy Markdown
Contributor

Adds a bundled code-wiki skill that turns any codebase into a structured wiki — README, architecture walkthrough, per-module docs, Mermaid class + sequence diagrams, getting-started guide. Inspired by Google CodeWiki but works on local repos, private repos, and any language.

Closes #486 (Phase 1 + 2 scope: full module/class/sequence diagrams + GitHub URL support; Phase 3 incremental updates deferred).

Why a skill, not a tool

Per AGENTS.md's "Skill vs Tool vs Plugin" framework: the entire capability is instructions + existing tools (terminal, read_file, search_files, write_file). Zero new model tools, zero schema bloat, zero new dependencies. Broadly useful → bundled, not optional.

Output

  • Default: ~/.hermes/wikis/<repo-name>/ (external to repo, like Google CodeWiki — never modifies the working tree)
  • In-repo (docs/wiki/) only when the user explicitly asks for it
  • All diagrams are Mermaid (renders natively on GitHub + most viewers)
  • .codewiki-state.json tracks source SHA + module list for re-runs
<output-dir>/
├── README.md              # overview, key concepts, module map
├── architecture.md        # system architecture + Mermaid flowchart
├── getting-started.md     # setup, install, first run
├── modules/<name>.md      # per-module deep dives
├── diagrams/
│   ├── architecture.md    # flowchart
│   ├── class-diagram.md   # classDiagram
│   └── sequences.md       # sequenceDiagram per workflow
├── api.md                 # (skipped if not a library/API)
└── .codewiki-state.json

Bounded scope

Generating exhaustive docs for huge repos is token-expensive. Defaults:

  • Max depth 3 on initial tree scan
  • Cap at 8–10 modules per pass (state list to user before generating)
  • search_files for symbols + read_file with offset/limit preferred over full reads
  • Skip vendored / generated code

If user says "do everything", believe them — but ballpark cost first.

Files

  • skills/software-development/code-wiki/SKILL.md — 445 lines; modern frontmatter, ≤60-char description, ## When to Use / Prerequisites / How to Run / Quick Reference / Procedure / Pitfalls / Verification structure
  • skills/software-development/code-wiki/templates/{README,architecture,getting-started,module}.md — starter scaffolds
  • website/docs/user-guide/skills/bundled/software-development/software-development-code-wiki.md — auto-generated
  • website/docs/reference/skills-catalog.md — one new row
  • website/sidebars.ts — one new entry

Verification

  • Description length 55 chars (≤60 hardline)
  • Author: Teknium (teknium1), Hermes Agent
  • Platforms: [linux, macos, windows] — only stdlib + git
  • All Mermaid code fences nest correctly (4-tick outer for example blocks containing 3-tick mermaid inner — common SKILL.md footgun)
  • Scope-disciplined docs regen: only my skill's auto-gen page + my one-line catalog/sidebar entries; unrelated drift reverted
  • Frontmatter parses with yaml.safe_load; all required sections present

Infographic

code-wiki skill

Bundled skill at skills/software-development/code-wiki/ that generates
comprehensive documentation for any codebase: project overview, architecture
walkthrough with Mermaid flowchart, per-module deep-dives, class diagram,
sequence diagrams, getting-started guide, and (when applicable) API reference.

Output defaults to ~/.hermes/wikis/<repo-name>/ (external to repo, like
Google CodeWiki); in-repo output supported when user explicitly requests it.

Uses only existing Hermes tools (terminal, read_file, search_files,
write_file) — no Docker, no external services, no extra dependencies. Works
on local repos and GitHub URLs (shallow-clones to a temp dir). Bounded scope
defaults (depth 3, cap 10 modules) keep token cost reasonable on large repos.
@alt-glitch alt-glitch added type/feature New feature or request P3 Low — cosmetic, nice to have tool/skills Skills system (list, view, manage) labels May 25, 2026
Per the 'when in doubt, optional' rule — wiki generation is a 'I want this
big thing right now' capability, not daily-driver behavior. Lines up with
finance/research/blockchain skills as install-on-demand rather than always
loaded.

Install via: hermes skills install official/software-development/code-wiki
@teknium1 teknium1 merged commit 5671461 into main May 25, 2026
17 checks passed
@teknium1 teknium1 deleted the hermes/hermes-0e17ee5a branch May 25, 2026 21:48
daletkc pushed a commit to daletkc/hermes-agent that referenced this pull request May 25, 2026
…arch#32240)

* feat(skills): add code-wiki skill — closes NousResearch#486

Bundled skill at skills/software-development/code-wiki/ that generates
comprehensive documentation for any codebase: project overview, architecture
walkthrough with Mermaid flowchart, per-module deep-dives, class diagram,
sequence diagrams, getting-started guide, and (when applicable) API reference.

Output defaults to ~/.hermes/wikis/<repo-name>/ (external to repo, like
Google CodeWiki); in-repo output supported when user explicitly requests it.

Uses only existing Hermes tools (terminal, read_file, search_files,
write_file) — no Docker, no external services, no extra dependencies. Works
on local repos and GitHub URLs (shallow-clones to a temp dir). Bounded scope
defaults (depth 3, cap 10 modules) keep token cost reasonable on large repos.

* refactor(skills): move code-wiki to optional-skills

Per the 'when in doubt, optional' rule — wiki generation is a 'I want this
big thing right now' capability, not daily-driver behavior. Lines up with
finance/research/blockchain skills as install-on-demand rather than always
loaded.

Install via: hermes skills install official/software-development/code-wiki
bridge25 pushed a commit to bridge25/hermes-agent that referenced this pull request May 27, 2026
…arch#32240)

* feat(skills): add code-wiki skill — closes NousResearch#486

Bundled skill at skills/software-development/code-wiki/ that generates
comprehensive documentation for any codebase: project overview, architecture
walkthrough with Mermaid flowchart, per-module deep-dives, class diagram,
sequence diagrams, getting-started guide, and (when applicable) API reference.

Output defaults to ~/.hermes/wikis/<repo-name>/ (external to repo, like
Google CodeWiki); in-repo output supported when user explicitly requests it.

Uses only existing Hermes tools (terminal, read_file, search_files,
write_file) — no Docker, no external services, no extra dependencies. Works
on local repos and GitHub URLs (shallow-clones to a temp dir). Bounded scope
defaults (depth 3, cap 10 modules) keep token cost reasonable on large repos.

* refactor(skills): move code-wiki to optional-skills

Per the 'when in doubt, optional' rule — wiki generation is a 'I want this
big thing right now' capability, not daily-driver behavior. Lines up with
finance/research/blockchain skills as install-on-demand rather than always
loaded.

Install via: hermes skills install official/software-development/code-wiki
mathias3 pushed a commit to mathias3/hermes-agent that referenced this pull request May 28, 2026
…arch#32240)

* feat(skills): add code-wiki skill — closes NousResearch#486

Bundled skill at skills/software-development/code-wiki/ that generates
comprehensive documentation for any codebase: project overview, architecture
walkthrough with Mermaid flowchart, per-module deep-dives, class diagram,
sequence diagrams, getting-started guide, and (when applicable) API reference.

Output defaults to ~/.hermes/wikis/<repo-name>/ (external to repo, like
Google CodeWiki); in-repo output supported when user explicitly requests it.

Uses only existing Hermes tools (terminal, read_file, search_files,
write_file) — no Docker, no external services, no extra dependencies. Works
on local repos and GitHub URLs (shallow-clones to a temp dir). Bounded scope
defaults (depth 3, cap 10 modules) keep token cost reasonable on large repos.

* refactor(skills): move code-wiki to optional-skills

Per the 'when in doubt, optional' rule — wiki generation is a 'I want this
big thing right now' capability, not daily-driver behavior. Lines up with
finance/research/blockchain skills as install-on-demand rather than always
loaded.

Install via: hermes skills install official/software-development/code-wiki
Bryce-huang pushed a commit to wbkunlun/hermes-agent that referenced this pull request May 29, 2026
…arch#32240)

* feat(skills): add code-wiki skill — closes NousResearch#486

Bundled skill at skills/software-development/code-wiki/ that generates
comprehensive documentation for any codebase: project overview, architecture
walkthrough with Mermaid flowchart, per-module deep-dives, class diagram,
sequence diagrams, getting-started guide, and (when applicable) API reference.

Output defaults to ~/.hermes/wikis/<repo-name>/ (external to repo, like
Google CodeWiki); in-repo output supported when user explicitly requests it.

Uses only existing Hermes tools (terminal, read_file, search_files,
write_file) — no Docker, no external services, no extra dependencies. Works
on local repos and GitHub URLs (shallow-clones to a temp dir). Bounded scope
defaults (depth 3, cap 10 modules) keep token cost reasonable on large repos.

* refactor(skills): move code-wiki to optional-skills

Per the 'when in doubt, optional' rule — wiki generation is a 'I want this
big thing right now' capability, not daily-driver behavior. Lines up with
finance/research/blockchain skills as install-on-demand rather than always
loaded.

Install via: hermes skills install official/software-development/code-wiki
#AI commit#
mosaiq-systems pushed a commit to mosaiq-systems/hermes-agent that referenced this pull request May 29, 2026
…arch#32240)

* feat(skills): add code-wiki skill — closes NousResearch#486

Bundled skill at skills/software-development/code-wiki/ that generates
comprehensive documentation for any codebase: project overview, architecture
walkthrough with Mermaid flowchart, per-module deep-dives, class diagram,
sequence diagrams, getting-started guide, and (when applicable) API reference.

Output defaults to ~/.hermes/wikis/<repo-name>/ (external to repo, like
Google CodeWiki); in-repo output supported when user explicitly requests it.

Uses only existing Hermes tools (terminal, read_file, search_files,
write_file) — no Docker, no external services, no extra dependencies. Works
on local repos and GitHub URLs (shallow-clones to a temp dir). Bounded scope
defaults (depth 3, cap 10 modules) keep token cost reasonable on large repos.

* refactor(skills): move code-wiki to optional-skills

Per the 'when in doubt, optional' rule — wiki generation is a 'I want this
big thing right now' capability, not daily-driver behavior. Lines up with
finance/research/blockchain skills as install-on-demand rather than always
loaded.

Install via: hermes skills install official/software-development/code-wiki
gweeteve pushed a commit to gweeteve/hermes-agent that referenced this pull request Jun 2, 2026
…arch#32240)

* feat(skills): add code-wiki skill — closes NousResearch#486

Bundled skill at skills/software-development/code-wiki/ that generates
comprehensive documentation for any codebase: project overview, architecture
walkthrough with Mermaid flowchart, per-module deep-dives, class diagram,
sequence diagrams, getting-started guide, and (when applicable) API reference.

Output defaults to ~/.hermes/wikis/<repo-name>/ (external to repo, like
Google CodeWiki); in-repo output supported when user explicitly requests it.

Uses only existing Hermes tools (terminal, read_file, search_files,
write_file) — no Docker, no external services, no extra dependencies. Works
on local repos and GitHub URLs (shallow-clones to a temp dir). Bounded scope
defaults (depth 3, cap 10 modules) keep token cost reasonable on large repos.

* refactor(skills): move code-wiki to optional-skills

Per the 'when in doubt, optional' rule — wiki generation is a 'I want this
big thing right now' capability, not daily-driver behavior. Lines up with
finance/research/blockchain skills as install-on-demand rather than always
loaded.

Install via: hermes skills install official/software-development/code-wiki
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P3 Low — cosmetic, nice to have tool/skills Skills system (list, view, manage) type/feature New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature: Code Wiki Skill — Auto-Generate Interactive Documentation & Architecture Diagrams from Any Codebase (inspired by Google CodeWiki)

2 participants