Skip to content
/ auto-docs Public

Auto-generate structured project documentation optimized for LLM agents. Uses TOON format with progressive disclosure.

Notifications You must be signed in to change notification settings

H1D/auto-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

auto-docs

Agent skill that auto-generates structured project documentation for all major AI coding tools.

Outputs to 5+ formats simultaneously so every tool benefits from one command:

Output Tools
AGENTS.md Codex, Gemini CLI, Jules, Copilot, Cursor, Windsurf, Aider, Roo Code, Kilo Code, Amp, OpenCode, and 20+ more
.ai/docs/ Canonical source — rich TOON progressive disclosure
CLAUDE.md Claude Code (@ import into .ai/docs/)
.cursor/rules/auto-docs.mdc Cursor
.github/copilot-instructions.md GitHub Copilot

Uses TOON for compact structured data (40-60% fewer tokens than JSON) and Markdown for narrative. Documentation is organized in three tiers with progressive disclosure — a tiny index is always loaded, feature details and architecture docs load on demand.

Install

npx skills add H1D/auto-docs

Usage

/auto-docs           # generate docs from scratch
/auto-docs update    # sync docs with code changes

What it generates

AGENTS.md                            # universal — 20+ tools read this
CLAUDE.md                            # Claude Code entry point with @import
.ai/docs/
├── index.toon                       # always loaded — feature catalog (~100 tokens)
├── overview.md                      # project summary + stack
├── architecture.md                  # component map + data flow
├── decisions.md                     # architectural decision records
├── dependencies.md                  # runtime, dev, internal dep maps
└── features/
    ├── auth.md                      # per-feature detail with embedded TOON
    └── payments.md
.cursor/rules/auto-docs.mdc         # Cursor-native format
.github/copilot-instructions.md     # GitHub Copilot

Includes a TOON validation script that checks both .toon files and ```toon blocks embedded in Markdown.

License

MIT

About

Auto-generate structured project documentation optimized for LLM agents. Uses TOON format with progressive disclosure.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published