mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-31 06:51:29 +00:00
5671461c0c
* 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
31 lines
667 B
Markdown
31 lines
667 B
Markdown
# {{PROJECT_NAME}}
|
|
|
|
{{ONE_PARAGRAPH_DESCRIPTION}}
|
|
|
|
## Key Concepts
|
|
|
|
- **{{CONCEPT_1}}** — {{ONE_LINE}}
|
|
- **{{CONCEPT_2}}** — {{ONE_LINE}}
|
|
- **{{CONCEPT_3}}** — {{ONE_LINE}}
|
|
|
|
## Entry Points
|
|
|
|
- [`{{PATH_1}}`]({{LINK_1}}) — {{WHAT_IT_DOES}}
|
|
- [`{{PATH_2}}`]({{LINK_2}}) — {{WHAT_IT_DOES}}
|
|
|
|
## High-Level Architecture
|
|
|
|
{{TWO_TO_THREE_SENTENCES}}
|
|
|
|
See [architecture.md](architecture.md) for the full picture.
|
|
|
|
## Module Map
|
|
|
|
| Module | Purpose |
|
|
|---|---|
|
|
| [`{{MODULE_1}}`](modules/{{MODULE_1}}.md) | {{ONE_LINE_PURPOSE}} |
|
|
| [`{{MODULE_2}}`](modules/{{MODULE_2}}.md) | {{ONE_LINE_PURPOSE}} |
|
|
|
|
## Getting Started
|
|
|
|
See [getting-started.md](getting-started.md).
|