CalvinBackup/gstack
1
0
Fork 0
mirror of https://github.com/garrytan/gstack.git synced 2026-06-17 23:30:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat(document-generate): add Diataxis documentation generation skill

Browse Source 
New /document-generate skill, the companion to /document-release. While
/document-release audits and fixes existing docs post-ship, /document-generate
writes missing documentation from scratch using the Diataxis framework.

Inspired by doodlestein documentation-website-for-software-project skill.

Co-Authored-By: Hermes Agent <agent@nousresearch.com>
This commit is contained in:
Hermes Agent
2026-05-11 12:34:01 +00:00
parent 1730a06135
commit 369bc62cf7
4 changed files with 1636 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
document-release/SKILL.md
+3 -2
View File
@@ -869,6 +869,7 @@ Use these definitions:
The coverage map feeds into Steps 2-3 (what to audit and fix) and Step 9 (documentation debt
summary in the PR body). Do NOT auto-generate missing documentation pages — flag gaps only.
When significant gaps are found, suggest running `/document-generate` to fill them.
---
@@ -1233,8 +1234,8 @@ If all coverage is complete and no diagrams drifted, output: "Coverage: all ship
- **Generic heuristics, not project-specific.** The audit checks work on any repo.
- **Discoverability matters.** Every doc file should be reachable from README or CLAUDE.md.
- **Coverage map informs, never generates.** The Diataxis coverage map flags gaps for the PR body
and future work. It does NOT auto-generate missing documentation pages or sections. The coverage
map is an audit tool, not a content generator.
and future work. It does NOT auto-generate missing documentation pages or sections. When gaps
are found, suggest `/document-generate` as the follow-up skill.
- **Diagram drift is advisory.** Flag stale architecture diagrams in the PR body but do not
auto-edit ASCII art or Mermaid blocks — they require human judgment to update correctly.
- **Voice: friendly, user-forward, not obscure.** Write like you're explaining to a smart person
document-release/SKILL.md.tmpl
+3 -2
View File
@@ -131,6 +131,7 @@ Use these definitions:
The coverage map feeds into Steps 2-3 (what to audit and fix) and Step 9 (documentation debt
summary in the PR body). Do NOT auto-generate missing documentation pages — flag gaps only.
When significant gaps are found, suggest running `/document-generate` to fill them.
---
@@ -495,8 +496,8 @@ If all coverage is complete and no diagrams drifted, output: "Coverage: all ship
- **Generic heuristics, not project-specific.** The audit checks work on any repo.
- **Discoverability matters.** Every doc file should be reachable from README or CLAUDE.md.
- **Coverage map informs, never generates.** The Diataxis coverage map flags gaps for the PR body
and future work. It does NOT auto-generate missing documentation pages or sections. The coverage
map is an audit tool, not a content generator.
and future work. It does NOT auto-generate missing documentation pages or sections. When gaps
are found, suggest `/document-generate` as the follow-up skill.
- **Diagram drift is advisory.** Flag stale architecture diagrams in the PR body but do not
auto-edit ASCII art or Mermaid blocks — they require human judgment to update correctly.
- **Voice: friendly, user-forward, not obscure.** Write like you're explaining to a smart person