mirror of
https://github.com/NousResearch/hermes-agent.git
synced 2026-05-30 06:41:51 +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
38 lines
634 B
Markdown
38 lines
634 B
Markdown
# Module: `{{MODULE_NAME}}`
|
|
|
|
{{ONE_TO_TWO_SENTENCE_PURPOSE}}
|
|
|
|
## Responsibilities
|
|
|
|
- {{BULLET_1}}
|
|
- {{BULLET_2}}
|
|
- {{BULLET_3}}
|
|
|
|
## Key Files
|
|
|
|
- [`{{PATH_1}}`]({{LINK_1}}) — {{WHAT_IT_DOES}}
|
|
- [`{{PATH_2}}`]({{LINK_2}}) — {{WHAT_IT_DOES}}
|
|
|
|
## Public API
|
|
|
|
### `{{FUNCTION_NAME}}({{SIGNATURE}})`
|
|
|
|
{{ONE_LINE_DESCRIPTION}}
|
|
|
|
**Parameters:**
|
|
- `{{PARAM}}` ({{TYPE}}) — {{DESCRIPTION}}
|
|
|
|
**Returns:** {{TYPE}} — {{DESCRIPTION}}
|
|
|
|
## Internal Structure
|
|
|
|
{{HOW_THE_MODULE_IS_ORGANIZED}}
|
|
|
|
## Dependencies
|
|
|
|
- **Used by:** {{OTHER_MODULES}}
|
|
- **Uses:** {{OTHER_MODULES_AND_LIBS}}
|
|
|
|
## Notable Patterns / Gotchas
|
|
|
|
- {{ANYTHING_NON_OBVIOUS}}
|