feature-doc

1# feature-doc: closed-loop feature documentation
2 
3Produces one evidence-backed feature article end to end. Capture needs no manual
4gesture: a bundled recorder grabs frames from the browser through the DevTools
5protocol. Publishing the docs PR stays a gate for you at CP-6.
6 
7## Configuration
8 
9Set these once (a `.env`, your `kit.toml`, or pass them as arguments). Nothing below is hardcoded.
10 
11| Setting | Meaning | Example |
12|---|---|---|
13| `APP_URL` | Start page of the live app to drive | `https://app.example.com/projects/1` |
14| `ISSUE_REPO` | Issue tracker holding the feature issues | `your-org/your-product` |
15| `DOCS_REPO` | Local path of the docs repo | `../your-docs` |
16| `DOCS_DIR` | Folder inside the docs repo for the article | `docs/features/` |
17| `EVIDENCE_DIR` | Where screenshots and video land | `./evidence/<feature>/` |
18 
19Keep the docs repo in a folder your tools can always read. Some operating systems block background reads of the Documents folder mid-session, which breaks the verifier.
20 
21## When to use
22- A shipped or shipping feature has no article, or an outdated one.
23- You want a doc that works as a user manual and as a guide to what you can do with the feature, with real screenshots and a video.
24 
25Skip it for backend features with no user surface (write a short "no doc required" record instead).
26 
27## Closed loop
28```
29CP-1 spec (issues/repo)  -> CP-2 plan (AC-n)  -> CP-3 build (capture + write)
30…