mirrors/hermes-agent
1
0
Fork 0
mirror of https://github.com/NousResearch/hermes-agent.git synced 2026-05-30 06:41:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
hermes-agent/optional-skills/software-development/code-wiki/templates/architecture.md
Teknium 5671461c0c
feat(skills): add code-wiki skill — closes #486 (#32240) 
* feat(skills): add code-wiki skill — closes #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
2026-05-25 14:48:53 -07:00

654 B
Raw Blame History

Architecture

{{TWO_TO_THREE_PARAGRAPHS_SHAPE_OF_SYSTEM}}

Components

  • {{COMPONENT_1}} — {{ONE_TO_TWO_SENTENCES}} See modules/{{MODULE}}.md.
  • {{COMPONENT_2}} — {{ONE_TO_TWO_SENTENCES}}

System Diagram

flowchart TD
    User([User]) --> Entry[Entry Point]
    Entry --> Core[Core Engine]
    Core --> StorageA[(Database)]
    Core --> ExternalAPI{{External API}}

Data Flow

  1. {{STEP_1}} — {{FILE}}
  2. {{STEP_2}} — {{FILE}}
  3. {{STEP_3}} — {{FILE}}

Key Design Decisions

  • {{DECISION_1}}
  • {{DECISION_2}}
  • {{DECISION_3}}