project-docs

1# Project Documentation Generator
2 
3Generate structured project documentation by analysing the codebase. Produces docs that reflect the **actual code**, not aspirational architecture.
4 
5## When to Use
6 
7- New project needs initial documentation
8- Docs are missing or stale
9- Onboarding someone to the codebase
10- Post-refactor doc refresh
11 
12## Workflow
13 
14### 1. Detect Project Type
15 
16Scan the project root to determine what kind of project this is:
17 
18| Indicator | Project Type |
19|-----------|-------------|
20| `wrangler.jsonc` / `wrangler.toml` | Cloudflare Worker |
21| `vite.config.ts` + `src/App.tsx` | React SPA |
22| `astro.config.mjs` | Astro site |
23| `next.config.js` | Next.js app |
24| `package.json` with `hono` | Hono API |
25| `src/index.ts` with `Hono` | API server |
26| `drizzle.config.ts` | Has database layer |
27| `schema.ts` or `schema/` | Has database schema |
28| `pyproject.toml` / `setup.py` | Python project |
29| `Cargo.toml` | Rust project |
30 
31### 2. Ask What to Generate
32 
33```
34Which docs should I generate?
351. ARCHITECTURE.md — system overview, stack, directory structure, key flows
362. API_ENDPOINTS.md — routes, methods, params, response shapes, auth
373. DATABASE_SCHEMA.md — tables, relationships, migrations, indexes
384. All of the above
39```
40 
41Only offer docs that match the project. Don't offer API_ENDPOINTS.md for a static site. Don't offer DATABASE_SCHEMA.md if there's no database.
42 
43### 3. Scan the Codebase
44 
45For each requested doc, read the relevant source files:
46 
47**ARCHITECTURE.md** — scan:
48…