skills.rest
dangvu008
dangvu008COMMUNITY
Explore all skills by this author →
GitHub

rune-docs

Generates and synchronizes README, API, architecture, and changelog documentation from codebase analysis.

1|Updated Mar 22, 2026
Search Tags:#git#changelog#documentation#readme#api reference#doc sync#code scanning
One-click install
npx skills add https://github.com/dangvu008/VietTruyen --skill rune-docs-dangvu008
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rune-docs
Source: https://github.com/dangvu008/VietTruyen/tree/main/.agents/skills/rune-docs
Command: npx skills add https://github.com/dangvu008/VietTruyen --skill rune-docs-dangvu008

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Project documentation quickly becomes outdated as code evolves, leading to READMEs, API references, and changelogs that contradict the actual implementation. This Skill generates documentation directly from source code and keeps it synchronized with every code change. ## Core Features & Use Cases - Documentation Generation: Scans the codebase to produce README.md, ARCHITECTURE.md, and API references with endpoints extracted from Express, FastAPI, NestJS, Next.js, SvelteKit, and Hono route definitions. - Incremental Sync: Detects code changes via git diffs and updates only the affected doc sections, flagging stale content that references deleted code. - Changelog Automation: Groups git commits by type and formats them as Keep a Changelog entries in CHANGELOG.md. - Cross-Doc Consistency: Verifies that versions, stats, feature lists, and commands match across README, CLAUDE.md, and other docs, fixing mismatches immediately. - Use Case: After shipping a new feature with three new API endpoints, run the update mode to refresh the README feature list, regenerate the API reference, and append a changelog entry in one pass. ## Quick Start Ask the agent to run the docs init command to scan your codebase and generate a README, architecture overview, and API reference from the actual code.

Frequently Asked Questions about rune-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I auto-generate a README from my codebase?▼

Run the docs init mode, which scans your project for entry points, routes, configuration files, and tech stack, then generates a README with Quick Start, Features, Tech Stack, and Configuration sections. Existing custom sections are merged rather than overwritten.

How to keep API documentation in sync with code changes?▼

Use the update mode, which reads git diffs since the last docs update, identifies new or changed routes, and regenerates only the affected doc sections. Deleted code is flagged or marked as removed rather than silently dropped.

Which API frameworks are supported for endpoint extraction?▼

Endpoint extraction supports Express, FastAPI, NestJS, Next.js App and Pages routers, SvelteKit, and Hono. Request and response shapes are pulled from Zod schemas, Pydantic models, and TypeScript types rather than inferred.

Can I generate a changelog from git commit history?▼

Yes, changelog mode groups commits by type and formats them following the Keep a Changelog convention, with sections for Added, Fixed, Changed, and Removed. Related changes are grouped under feature headers and breaking changes are highlighted.

What happens if generated docs contradict each other?▼

A cross-document consistency pass compares version numbers, feature lists, stats, and commands across README, CLAUDE.md, and other docs. Mismatches are fixed immediately by updating the stale document to match the source of truth.

Will it document features that are planned but not implemented?▼

No, a hard constraint requires every documented statement to be traceable to an actual file, function, or configuration in the codebase. Unimplemented work can only be described as a plan in explicit spec documents, never as existing functionality.

Related Skills

Explore More Software Engineering Skills→
VYRE-StudiosVYRE-Studios

documentation

Generate READMEs, API references, and architecture docs from source code.

Official
Intermediate
tigredonortetigredonorte

create-jira-wiki

Publish Jira task design documents to a wiki repository.

Community
Advanced
PostHogPostHog
713

writing-code-comments

Reviews and rewrites code comments to explain why rather than restate what the code does.

Official
Basic
rodmena-limitedrodmena-limited
3

moai-docs-generation

Generate documentation from source code and API annotations using Sphinx, MkDocs, TypeDoc, and Nextra.

Official
Advanced