docs

Solid

Auto-generate and maintain project documentation. Creates README, API docs, architecture docs, changelogs, and keeps them in sync with code changes. The "docs are never outdated" skill.

AI & Automation 81 stars 23 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 88/100

Stars 20%
64
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# docs ## Purpose Documentation lifecycle manager. Generates initial project documentation, keeps docs in sync with code changes, produces API references, and auto-generates changelogs. Solves the #1 documentation problem: docs that exist but are outdated. <HARD-GATE> Docs MUST be generated from actual code, not invented. Every statement in generated docs must be traceable to a specific file, function, or configuration in the codebase. If code doesn't exist yet, docs describe the PLAN, not the implementation. </HARD-GATE> ## Triggers - Called by `scaffold` Phase 7 for initial documentation generation - Called by `cook` post-Phase 7 to update docs after feature implementation - Called by `launch` pre-deploy to ensure docs are current - `/rune docs init` — first-time documentation generation - `/rune docs update` — sync docs with recent code changes - `/rune docs api` — generate API documentation - `/rune docs changelog` — auto-generate changelog from git history ## Calls (outbound) - `scout` (L2): scan codebase for documentation targets (routes, exports, components, configs) - `doc-processor` (L3): generate PDF/DOCX exports if requested - `git` (L3): read commit history for changelog generation ## Called By (inbound) - `scaffold` (L1): Phase 7 — generate initial docs for new project - `cook` (L1): post-implementation — update docs for changed modules - `launch` (L1): pre-deploy — verify docs are current - `mcp-builder` (L2): generate MCP server documentation - User: `...

Details

Author
Rune-kit
Repository
Rune-kit/rune
Created
5 months ago
Last Updated
3 days ago
Language
JavaScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category