Does this skill invent or hallucinate features?

No. The skill is strictly constrained to generate documentation based on actual code. Every statement must be traceable to a specific file, function, or configuration in the codebase.

How does it handle code that has been deleted?

The update mode detects git diffs and flags or removes documentation sections that reference code that no longer exists to prevent stale information.

What frameworks are supported for API documentation?

It supports a wide range of frameworks including Express, FastAPI, NestJS, Next.js, SvelteKit, and Hono by detecting specific routing patterns and type schemas.

Will it overwrite my manual edits in the README?

The skill is designed to merge changes and preserve existing documentation. It detects custom sections and updates only the code-derived parts of your files.

Automated Project Documentation

Name: Automated Project Documentation
Author: Rune-kit

byRune-kit

•

Learning & Documentation

Generates and synchronizes project documentation to ensure READMEs, API references, and architecture guides stay in sync with your code.

The docs skill is a comprehensive documentation lifecycle manager designed to solve the problem of outdated project manuals. It intelligently scans your codebase using the 'scout' utility to extract project structures, tech stacks, and API routes, generating traceable documentation including READMEs, ARCHITECTURE.md, and API.md. By integrating with git history and performing cross-document consistency passes, it ensures that your documentation, changelogs, and version numbers remain accurate and synchronized with every code change.

Key Features

01Auto-generates READMEs with Quick Start guides and project structure maps

02Performs cross-doc consistency checks to prevent contradictory information

03Extracts API routes and schemas to create live API.md documentation

04Maintains ARCHITECTURE.md with system diagrams and data flow descriptions

0558 GitHub stars

06Synchronizes CHANGELOG.md automatically from git commit history

Use Cases

01Ensuring README stats and version numbers match across all project files before a release

02Automatically updating API references after modifying backend routes or types

03Bootstrapping comprehensive documentation for a new repository in seconds

Key Features

01Auto-generates READMEs with Quick Start guides and project structure maps

02Performs cross-doc consistency checks to prevent contradictory information

03Extracts API routes and schemas to create live API.md documentation

04Maintains ARCHITECTURE.md with system diagrams and data flow descriptions

0558 GitHub stars

06Synchronizes CHANGELOG.md automatically from git commit history

Use Cases

01Ensuring README stats and version numbers match across all project files before a release

02Automatically updating API references after modifying backend routes or types

03Bootstrapping comprehensive documentation for a new repository in seconds