Skip to content

Latest commit

Β 

History

188 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Docforge

DOCFORGE

[ insert repository :: generate documentation :: no invented lore ]

Version Agent Skill MIT License


An Agent Skill that writes documentation grounded in the actual source β€” code graphs, manifests, git history. Every claim carries provenance; every document is audited before it counts.

PRECHECK β†’ ANALYZE β†’ PLAN β†’ WRITE β†’ AUDIT β†’ TRACK

β–Έ install

npx skills add jonaskahn/docforge       # this project
npx skills add jonaskahn/docforge -g -y # every project

Claude Code native marketplace:

/plugin marketplace add jonaskahn/docforge
/plugin install docforge@docforge

Either path installs skills/docforge β€” the required core. docforge-revise and docforge-dashboard below are thin entrypoints on top of it.


β–Έ skills

Plain language works β€” "Document this repository from scratch", "Check which docs have drifted". Or call a skill directly:

/docforge β€” fresh start. Intake asks scope in two short turns (goal, layout, and target readers β€” Human, AI coding agents, or Both β€” then tier, profiles, and audience), summarizes, and waits for your confirm before writing anything.

/docforge intake β†’ plan β†’ write
/docforge --plan-only plan / dry-run only, nothing written

/docforge-revise β€” keep it current. Re-grounds what drifted; a bare run only syncs manifest metadata, no questions asked.

/docforge-revise sync manifest only
/docforge-revise all full-tree structural refresh
/docforge-revise <area> scoped refresh, e.g. architecture, reference, agents
/docforge-revise flow flow harvest β†’ organize β†’ derive β†’ write
/docforge-revise flow --plan-only flow analysis only, no body writes

/docforge-dashboard β€” liquid docs. Serves the written tree as a local Fumadocs site.

/docforge-dashboard reconcile β†’ rebuild if changed β†’ serve β†’ open
/docforge-dashboard --plan-only preflight + route plan, no build
/docforge-dashboard export static export to <dashboard>/out/
/docforge-dashboard status read-only: signatures, server state, doc count
/docforge-dashboard stop stop the detached dev server

flags, any skill β€” --plan-only dry-run Β· --auto-accept skip routine pauses Β· --no-dashboard skip the auto dashboard step Β· --help full reference in help.md.


β–Έ demo

Docforge dashboard preview (dark mode) Docforge dashboard preview (light mode)


β–Έ requirements

a compatible AI coding agent Β· git Β· Python 3.10+ or Node.js 22+ / Bun / Deno Β· Node.js 22+ and npm for the dashboard only

Details: workflows Β· document contracts Β· provenance model



Created by Jonas Kahn Β· MIT Β· issues Β· pull requests

About

πŸ€– Just a skill to let AI generate documents based on your source code πŸ”…

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages