Documentation written with the work, not after it
The Handbook is never behind your specs
Not your code: nothing here reads code, so a spec built differently and still marked done produces a page that is wrong. What the Handbook notices is a spec that moved.
Every page knows what it was written against
A pin holds the exact content a page was written from: a document's blob SHA, an artifact's version. Freshness compares those, never a date.
- Current
- Every pin matches its source. Readers see the names of the sources.
- Out of date
- A spec the page pins was marked done in a newer version, or a source changed. Readers see which one and since when, before anyone is misled.
- Source changed, not built yet
- Shown to editors only. A spec edited on Monday does not mark the page wrong before the work exists.
- Still correct
- A person confirms an out-of-date page is right as it stands. The pins move, the text stays, and no credits are spent.
Out of date since “Partial refunds” was marked done
- specs/payments/refunds.md
- specs/payments/partial-refunds.md
- adr/0007-idempotency-keys.md
The agent that built the feature drafts the page
Your own coding agent reports the build through MCP and proposes the Handbook change in the same report. Docs Flowy runs no coding agent of its own.
- 01An agent reports the buildWhen it starts, it learns which pages pin the spec it is working on. When it finishes, its report carries the updated page, or the reason no reader would see a change.
- 02The change opens a requestNobody edits the live Handbook. Every edit, from a person or an agent, is a change request against the version it was written from.
- 03A person applies itAn approver reads the change and applies it, or rejects it with a reason. If another change to the page landed first, this one is outdated and cannot be applied as it stands.
Agents may propose Handbook changes is a project setting, on by default. An agent writes Team pages only: a claim that names a page shown on the public site is refused.
The built-in assistant drafts a page only when a person asks for one in the console, and spends the organization's credits.
Write once in Team. Arrange what goes public.
Team
Every page is written, reviewed and approved here. It is the only place a page's content is edited.
Public
Entries that point at Team pages, in folders, order and public titles of your choosing. An entry's text mirrors its Team page, so nothing drifts and nobody edits a copy.
What each plan includes
- The Team Handbook, with pages written by hand or with the assistant
- Every plan
- Pages that fall due when a spec is marked done, and agent change requests
- Starter and up
- A public site for the Handbook
- Starter and up
The assistant spends credits on every plan.
Write the page while the work is fresh
Connect a repository, start the Handbook and pin its first page to a spec.
Start free