Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

152 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Docforge

DOCFORGE

INSERT REPOSITORY. GENERATE DOCUMENTATION. NO INVENTED LORE.

Version Agent Skill MIT License

β–Ί PRESS START


An Agent Skill cartridge for AI coding agents: designs, writes, audits, and maintains documentation grounded in the actual source β€” code graphs, manifests, git history, repository evidence. Every claim carries a blob-stamped provenance, every document passes an independent audit before it counts.

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

Docforge reads the repository's own size and shape before deciding how big the docs should be: a small repo gets compact layout β€” the same subjects, folded into fewer, denser files β€” while a large one gets the full standard tree; either way you can override the suggestion. Documents that fall out of scope on a later run (tier downgrade, dropped profile, layout switch) are retired, not deleted out from under you β€” moved to a git-ignored .docforge/obsolete/<year>/ (or removed, if you say so explicitly) with the history kept in the manifest.

β–ˆβ–ˆβ–“β–’β–‘ INSERT COIN β–‘β–’β–“β–ˆβ–ˆ

# Agent Skills β€” insert in the current project
npx skills add jonaskahn/docforge

# or globally
npx skills add jonaskahn/docforge -g -y

Claude Code native marketplace:

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

Both paths load skills/docforge β€” the required core bundle. docforge-revise and docforge-dashboard are thin optional entrypoints on top of it.

β–ˆβ–ˆβ–“β–’β–‘ HOW TO PLAY β–‘β–’β–“β–ˆβ–ˆ

Invocation order is always command β†’ scope args β†’ flags. Plain language works across compatible agents:

Document this repository from scratch.
Create diligence documentation for this service.
Generate ADRs from the repository history.
Check which generated docs have drifted from source.

/docforge β€” fresh start

Intake, plan, or write a tree from scratch. On intake it performs only read-only discovery, then asks its scope questions in two turns: first your goal and the documentation layout, then tier, repository profiles, audience, graph source, and execution mode. It finally summarizes the complete scope and asks you to confirm, edit, or cancel before writing anything.

Command Use
/docforge Fresh start: intake, plan, or write
/docforge --plan-only Plan / dry-run tree only

/docforge-revise β€” keep it current

Re-ground what drifted; a bare run only syncs manifest metadata.

Command Use
/docforge-revise Migrate/upgrade manifest metadata only β€” no questions, no writing
/docforge-revise all Full-tree structural refresh
/docforge-revise <area> Scoped revise (architecture, flows, operations, …)
/docforge-revise flow Flow harvest β†’ organize β†’ derive β†’ write
/docforge-revise flow --plan-only Flow analysis only (no body writes)

/docforge-dashboard β€” liquid docs

Render the written docs as a local Fumadocs site (Liquid Glass theme).

Command Use
/docforge-dashboard dashboard start: reconcile β†’ rebuild when changed β†’ serve β†’ open
/docforge-dashboard --plan-only Preflight, metadata dry-run, signatures, route plan
/docforge-dashboard export Static export (next build β†’ <dashboard>/out/) for GitHub Pages / S3
/docforge-dashboard status Read-only: signature match, server state, document count
/docforge-dashboard stop Stop the detached dev server

CHEAT CODES

--plan-only β€” analyze / dry-run tree only. --auto-accept β€” skip routine pauses after the scope confirm. --no-dashboard β€” skip the automatic dashboard build/serve at completion. --help β€” per-command reference (canonical text in help.md).

β–ˆβ–ˆβ–“β–’β–‘ DEMO β–‘β–’β–“β–ˆβ–ˆ

The cabinet's attract mode after a run:

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

β–ˆβ–ˆβ–“β–’β–‘ SYSTEM REQUIREMENTS β–‘β–’β–“β–ˆβ–ˆ

  • a compatible AI coding agent
  • git
  • one tool runtime: Python 3.10+ or Node.js 22+ / Bun / Deno
  • Node.js 22+ and npm only for the dashboard install/serve steps

Full procedure and policy: workflows, document contracts, provenance model.

β–ˆβ–ˆβ–“β–’β–‘ CREDITS β–‘β–’β–“β–ˆβ–ˆ

Created by Jonas Kahn. SPDX-License-Identifier: MIT β€” LICENSE. Bugs: issues. Contributions: pull requests.

GAME OVER? NO. CONTINUE. β†’

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