v1.35.0.0 feat: add /document-generate skill + enhance /document-release with Diataxis coverage map#1477
Open
garrytan wants to merge 7 commits into
Open
v1.35.0.0 feat: add /document-generate skill + enhance /document-release with Diataxis coverage map#1477garrytan wants to merge 7 commits into
garrytan wants to merge 7 commits into
Conversation
…ction, and docs debt tracking Inspired by @doodlestein's documentation-website skill. Three key ideas incorporated: 1. Step 1.5: Coverage Map (Blast-Radius Analysis) — before editing any docs, scan the diff for new public surface and assess documentation coverage across Diataxis quadrants (reference/how-to/tutorial/explanation). Flags gaps without auto-generating content. 2. Architecture diagram drift detection — extracts entity names from ASCII/Mermaid diagrams and cross-references against the diff to catch stale diagrams. 3. Enhanced CHANGELOG sell test — Diataxis rubric scoring (0-3) replaces the subjective 'would a user want this?' check. 4. Documentation Debt section in PR body — surfaces coverage gaps and diagram drift as actionable items for future work. All changes are audit-only: the skill flags what's missing, never auto-generates missing documentation pages. Stays in its lane as a post-ship updater. Co-Authored-By: Hermes Agent <agent@nousresearch.com>
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>
CI's check-freshness step ran gen:skill-docs and found llms.txt stale — the index wasn't regenerated when /document-generate was added in the preceding commit. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Main brought in the Non-ASCII characters directive in the AskUserQuestion Format resolver (scripts/resolvers/preamble/generate-ask-user-format.ts). Regenerating document-generate/SKILL.md propagates the new section into the generated output. check-freshness should now pass. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Fork PRs from non-collaborators don't get base-repo secrets passed to their CI workflows, so eval/E2E jobs fail with empty-env auth. New section: when checking out a PR from garrytan-agents, push the branch to garrytan/gstack and re-target the PR from there. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
E2E Evals: ✅ PASS3/3 tests passed | $.33 total cost | 12 parallel runners
12x ubicloud-standard-2 (Docker: pre-baked toolchain + deps) | wall clock ≈ slowest suite |
- README.md: add /document-generate to skills table (Technical Writer
category) + install-command skill lists
- CLAUDE.md: add document-generate/ to project structure tree
- SKILL.md.tmpl + regenerated SKILL.md: add /document-generate routing
line ("write docs from scratch")
- VERSION: 1.34.0.0 → 1.35.0.0 (MINOR: new skill + enhancement)
CHANGELOG entry deferred to /ship.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Inspired by @doodlestein's documentation-website skill and the FrankenTUI docs site it produced. Two changes:
/document-generateskill — writes missing documentation from scratch using the Diataxis framework/document-release— now audits documentation coverage gaps and suggests/document-generateas follow-upThese two skills compose like Unix pipes:
/document-releasefinds what's missing,/document-generatefills the gaps.New: /document-generate
Writes high-quality documentation from scratch for a feature, module, or entire project. Uses the Diataxis framework (tutorial / how-to / reference / explanation).
9-step workflow:
0. Scope and Intent — confirm target, output format, where docs go
Key design principles stolen from @doodlestein:
Enhanced: /document-release
Step 1.5: Coverage Map (Blast-Radius Analysis)
New step between Pre-flight and Per-File Audit. Scans the diff for new public surface and assesses documentation coverage across Diataxis quadrants. Flags gaps but never auto-generates — suggests
/document-generatewhen significant gaps are found.Architecture Diagram Drift Detection
Parses entity names from ASCII/Mermaid diagrams, cross-references against the diff. Flags stale diagrams.
Enhanced CHANGELOG Sell Test
0-3 Diataxis rubric: +1 for "what changed" (reference), +1 for "why care" (explanation), +1 for "how to use it" (how-to). Entries scoring less than 2 get rewritten.
Documentation Debt in PR Body
Step 9 now appends a
### Documentation Debtsection with critical gaps, common gaps, and stale diagrams.Files Changed
document-generate/SKILL.md.tmpl— NEW template for /document-generatedocument-generate/SKILL.md— generated outputdocument-release/SKILL.md.tmpl— enhanced templatedocument-release/SKILL.md— regenerated outputNeed help on this PR? Tag
@codesmithwith what you need.Documentation
document-generate/to project structure tree; added new "Checking out PRs from garrytan-agents" section documenting the fork-PR secret-access workflow/document-generateentryDocumentation Debt
The following are flagged for follow-up (not blocking this PR):
/shipwhen the PR is ready to land (one entry under## [1.35.0.0]covering both the new skill and the doc-release enhancements).docs-debtlabel recommended on this PR.