40 lines
2.4 KiB
Markdown
40 lines
2.4 KiB
Markdown
|
---
|
||
|
|
name: docwriter
|
||
|
|
description: Keep Time Machine's human docs in sync — README, docs/SETUP.md, CLAUDE.md, .env.example. Document what the code actually does; never paste real secrets.
|
||
|
|
---
|
||
|
|
|
||
|
|
# /docwriter — documentation
|
||
|
|
|
||
|
|
Keep **Time Machine**'s docs true (see `CLAUDE.md`).
|
||
|
|
|
||
|
|
## Surfaces
|
||
|
|
- **`README.md`** — what it is, the feature model (Today / Review / rollover / Work·Home),
|
||
|
|
dev quick start, the scripts table.
|
||
|
|
- **`docs/SETUP.md`** — the operational bible: env vars, the **create-the-database** step,
|
||
|
|
local dev, Docker build, NAS deploy (`npm run deploy` and on-NAS `deploy.sh`), reverse-proxy
|
||
|
|
mapping, and backup notes.
|
||
|
|
- **`CLAUDE.md`** — the map future agents load: roster, invariants, paths, port/domain/DB.
|
||
|
|
- **`.env.example`** — every required var with a safe placeholder.
|
||
|
|
|
||
|
|
## Rules
|
||
|
|
- **Verify against source before writing** — read the code/scripts, don't guess.
|
||
|
|
- Keep the constants consistent everywhere: port **3099**, domain
|
||
|
|
**time-machine.mycloud.dp.ua**, DB **time_machine**, NAS path
|
||
|
|
**/volume1/docker/time-machine**.
|
||
|
|
- **Never** commit a real secret. Prefer editing an existing doc over adding a new one.
|
||
|
|
- Match the existing tone: concise, concrete, skimmable. End with `## Next`.
|
||
|
|
|
||
|
|
## Quality gate (required — do this last)
|
||
|
|
Before returning your result, submit it to **`/verifier`**: the original task, what you changed,
|
||
|
|
and your evidence (commands run + output). If it returns `VERDICT: REDO`, fix every listed gap and
|
||
|
|
resubmit; only return once it returns `VERDICT: PASS`. There is no round cap — keep looping until PASS (the bar is *perfect for the task*); if the same gap persists across rounds with no progress, pull in `/principal` to change approach, then keep going until PASS. Never skip this (`/verifier` itself is exempt, to avoid recursion).
|
||
|
|
|
||
|
|
## Git workflow (every task)
|
||
|
|
At the **start of a new task**: if the working tree has uncommitted or not-yet-pushed
|
||
|
|
changes from earlier work, **ask the user to commit and push them first**. Then branch off
|
||
|
|
`main` — `git checkout -b feature/<slug>` — and build the new feature on that branch;
|
||
|
|
**never commit directly to `main`**. Commit at the end and `git push -u origin <branch>`.
|
||
|
|
If you were auto-spawned mid-chain, or are a read-only agent (e.g. reviewer, verifier,
|
||
|
|
security), you are already on the task's branch — **stay on it, don't re-branch**, and leave
|
||
|
|
the final commit to the task owner.
|