generate-docs

Solid

Generate or update incremental developer documentation in the target project's own docs site: diff-driven how-to guides for what a unit of work changed, written through a discovered docs adapter (Starlight/Astro MDX is the first-class reference; plain markdown is the always-available fallback). Never a whole-project pass; never scaffolds a website; never edits source code. On Claude Code and want hand-tuned per-skill model/effort tiers? Install the `#claude` branch instead (`npx skills add gtrabanco/agentic-workflow#claude`) — see the README. This branch is model-agnostic: the skill inherits whatever model and effort your agent session is already using. Triggers: "generate the docs", "update the docs site", "document this unit", "document what changed", "generate-docs".

AI & Automation 19 stars 3 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 82/100

Stars 20%
43
Recency 20%
90
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Generate Docs Turn the knowledge produced by a unit of work into developer documentation a contributor can read on the project's docs website — incrementally, as a by-product of shipping, so a public repo's docs stay current instead of rotting. A commit says what changed; a guide says how to use it ("how do I create a domain event and where do I register its handler"). ## Turn contract — verify before ending the turn ``` ✓ The docs adapter was resolved through the Step 0 detection checklist and the outcome (adapter name, or NOT CONFIGURED) is stated in the report ✓ Every generated/updated page is WRITTEN to disk (paths listed in the report) and carries the provenance frontmatter — or zero pages were written and the report says exactly why ✓ The verify step was RUN (docs build command or link check) and its result pasted — never assumed ✓ Artifact language: explicit user instruction > the project's declared docs language > English. The CONVERSATION language never decides ✓ The fixed report block is printed, then the closing `→ Next:` block, as the ABSOLUTE last output ``` About to end the turn with any box unchecked? The turn is NOT done — complete the missing box first (weak models drop end-of-document duties; this list is first on purpose). ## When to use - **After finishing a unit of work** — `execute-phase` recommends this skill at close-out when the project declares a docs site: document what the unit changed while the context is fresh. - **On dema...

Details

Author
gtrabanco
Repository
gtrabanco/agentic-workflow
Created
1 months ago
Last Updated
1 weeks ago
Language
TypeScript
License
MIT

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category