Files
pipelines/internal/author/skill/references/orchestration.md
T
alan a3f571d672 docs: make docs-fold the single writer of shared documentation
Every item wrote the shared, append-only docs (android/README.md, docs/cli.md and
the packaged skill references), so every merge conflicted on prose. Keep the duty
to notice stale docs; move the writing to one deliberate place.

- Per-item note, not a shared edit. An item that makes a shared document stale
  writes docs/notes/<slug>.md - unique per item, so two items never touch the same
  file - and commits that note with its change. It never edits a README, topic doc
  or packaged skill reference itself.
- One writer. The manual-only docs-fold pipeline, bundled as the fifth starter
  examples/docs-fold.md, folds every note under docs/notes/ into the shared
  document it names and deletes the consumed notes in its own commit; an empty
  notes directory is a success no-op. Operator trigger:
  pipelines new "Docs fold" --template docs-fold --no-open; pipelines submit
  <draft.md>; pipelines run "Docs fold".
- Implemented where the convention lives: orchestration.md (brief item 5, the
  hard-constraint bullet, a "Single documentation writer" section and the
  "Pipeline choice" committer bullet), the canonical committer checklist in
  format.md (new step 6), the committer prompts in examples/task.md and
  examples/three-stage.md, the new examples/docs-fold.md with its catalog and
  README entries, and the repository guideline AGENTS.md. Test-expectation counts
  (examples/catalog_test.go, internal/server/templates_test.go,
  scripts/smoke-first-install.py) follow the fifth starter.

Reflected where it belongs: the packaged templates (examples/task.md,
examples/three-stage.md, the new examples/docs-fold.md), the packaged skill
references (orchestration.md, format.md) and the repo guideline AGENTS.md all carry
the new convention. No new reference file was added, so install.go's managed
inventory is unchanged. The shared descriptive docs were deliberately not
rewritten: this change makes README.md:191, docs/cli.md:170 and
internal/author/skill/references/operations.md:13 name four starters where there are
now five. Those stay as they are - correcting them now is exactly the per-item
shared edit this change removes - and the stale-doc note
docs/notes/docs-fold-single-writer.md records each one for the docs-fold writer to
fold. Nothing else needed updating. No new dependency; no Android, Gradle, server,
installer, Docker or published-definition change; no definition published over the
running pipelines.

Evidence: go test -count=1 ./... passed; go build ./... and go vet on the touched
packages clean; ./internal/author/... covers embedding, reference links, the managed
inventory and install/upgrade/protection; ./examples/... validates the fifth starter
and its manual-only, committer-terminated graph; ./internal/server/... covers the
served catalog. Not run: the docs-fold writer against the shared docs (nothing to
fold yet); no install or deploy.

(cherry picked from commit f29656cf084d7eee2e033f2a37a9d231d7acaaf0)
2026-10-17 23:59:59 +01:00

11 KiB

Orchestrate work through runs

When the operator asks for a change to this project, the agent's product is a set of briefs and a set of managed runs, not the change itself. The implementer stage makes the change; the reviewer stages check it; the committer stage commits it. Route all project work through Pipelines runs.

Stance

  • Reconnoitre first. Read enough of the repository, its notes and recent history to write a truthful brief: name the exact files, functions, commands and existing helpers the change touches. Do not guess and do not hand-roll the change to avoid reading.
  • Then route every work item through a run. Do not edit the project's files yourself, not even a one-line unblock. A hand edit has no brief, no independent review and no recorded run, so nothing about it can be reviewed or trusted.
  • Fix the cause, not the symptom. When a run wedges, fix the pipeline definition, the stage configuration or the Pipelines/harness service. Do not reach around a stuck stage and finish its work by hand. Diagnose with references/debugging.md.
  • The agent decides scope, decomposition, pipeline choice and what to publish; the operator owns the decisions a run cannot make — which items to accept, what to publish, when to restart a service, when to install on real hardware. Ask only for those.

Work items

Decompose the request into single-purpose items, roughly an hour of agent work each.

  • One item is one coherent change with its own brief, its own evidence and its own review, so the operator can review it on its own.
  • One item = one run = one commit (the committer stage commits). Do not batch unrelated changes into one run; a run whose reviewer is arguing about two independent changes is unreviewable.
  • State dependencies and ordering: which items must land first and which are independent. Independent items may go to parallel lanes (references/lanes.md); dependent items run in order.
  • Prefer more, smaller items to fewer large ones: a smaller item is cheaper to review, cheaper to retry, and less likely to loop back through the reviewer.

The brief

A brief is the entire task a run receives. The run does not see this conversation, the operator's intent beyond the brief's words, or any context that is not on disk. Write it self-contained.

Every brief has:

  1. Goal — one line naming the change.
  2. The observed problem — what is wrong today and why it matters, in the repository's own terms, naming the exact files, commands or runs.
  3. Requirements — a short bulleted list of the exact behaviour, the surfaces it touches, and every constraint the change must honour.
  4. Falsifiable evidence required — the exact commands the run must run and the output it must report, plus the screenshots the reviewer must read. Say plainly: "report the exact commands and their observed results. Do not claim a check you did not run."
  5. Documentation note — where the change makes shared documentation stale, the item records that in its own per-item note docs/notes/<slug>.md: what it changed and which shared document (a README or topic doc, or a packaged skill reference) is now stale and what should change there. The item writes only its note; it must not edit a shared document. See "Single documentation writer" below.
  6. The hard constraints block (below).
  7. Publishing rules (references/delivery.md).

Template:

<one-line goal: the change, in the repository's own words.>

<what is wrong today and why it matters; name the exact files, commands or runs.>

- <requirement 1: the behaviour and the surface it touches>
- <requirement 2>
...

Evidence: <exact build/test commands> and <the screenshots or captures asked for>;
report the exact commands and their observed results. Do not claim a check you did
not run.

Constraints: <scope: the one subtree or package this item may touch>; no new
dependencies; do not restart, rebuild or reconfigure the Pipelines or OpenCode
server, the installer, the ntfy service or any other service - runs and lanes are
active; never install on the operator's physical device; keep geometry and values
from their single existing sources rather than new literals; commit locally only,
never push; record a documentation note in `docs/notes/<slug>.md` rather than editing
a shared document; <the item's publishing rules>.

Requirements must be concrete and checkable. Name files, functions, commands, and the existing helpers to reuse. State what must survive — existing behaviour, other lanes' work. If a requirement cannot be checked by a command or by an image a reviewer can open, it is not evidence: rewrite it.

Do not write a brief that asks a stage to do a vague job ("make the UI better"). A reviewer cannot falsify it and the run will drift. One item, one observable outcome.

Hard constraints to carry into every brief

Adapt the scope and publishing lines per item; keep the rest.

  • Scope — the single subtree or package the item may touch, and nothing else.
  • No new dependencies unless the brief argues the exception in-line.
  • Do not restart, rebuild or reconfigure the Pipelines server, the CLI, the installer, the OpenCode service or ntfy, and do not touch another lane's worktree or device.
  • Never install on the operator's physical device — only the lane's own emulator or device (references/lanes.md).
  • Keep values from single sources — geometry, tokens, sizes and constants come from the source that already owns them, not from new literals.
  • Commit locally only, never push — the committer stage commits, no other stage.
  • Record stale documentation; do not rewrite it — before committing, the committer ensures the item's docs/notes/<slug>.md note, when the change makes a shared document stale, is staged with the change, and states in the commit body what it checked. The committer never edits a shared document (a README or topic doc, or a packaged skill reference) itself; the single documentation writer folds notes later.
  • Publish rules — WIP artefact naming and LAN URLs per references/delivery.md.

Single documentation writer

Shared documentation — the repository's READMEs and topic docs (for this repository android/README.md and docs/cli.md) and the packaged skill references in internal/author/skill/references/ — has exactly one writer, never an item. Each item that makes one of these stale leaves a note at docs/notes/<slug>.md (item 5 above). The note's filename is unique per item, so two items never write the same file and never conflict on prose.

The writer is the manual-only docs-fold pipeline, bundled as the starter examples/docs-fold.md. Its fold stage reads every note under docs/notes/, folds each into the shared document it names, and deletes the consumed notes in its own commit; an empty docs/notes/ is a success no-op with no empty commit. It is never scheduled and is never part of a per-item workflow.

The operator triggers it deliberately:

pipelines new "Docs fold" --template docs-fold --no-open
pipelines submit <draft.md>
pipelines run "Docs fold"

Pipeline choice

  • Use a pipeline that keeps implementer + reviewer + ui_reviewer + committer for anything that matters. The planner is the only stage a leaner variant may drop.
  • Never remove a review stage to go faster. The reviewer stages are the independent evidence the operator reviews against; dropping them is exactly how a regression ships unreviewed.
  • The ui_reviewer must build, capture and read the actual screenshots, or return skipped with a reason when the change has no rendered surface. Never accept a UI change approved without the images.
  • The committer is the only stage that commits, and it stages only the run's changed files. Before committing it ensures the item's docs/notes/<slug>.md note, when the change makes a shared document stale, is staged with the change, and states in the commit body what it checked; it never edits a shared document (a README or topic doc, or a packaged skill reference) itself, because a single documentation writer folds notes later. It must also select input.server_changed_files (the runner's captured evidence, references/control.md) alongside the implementer's declared changed_files and stage their union: an implementer's declared list can be incomplete, and a captured path it omitted is still this run's change. Its prompt carries the pre-commit checklist in references/format.md; it commits locally and stops, never pushing.
  • A run cannot approve its own work. When an item genuinely needs an operator gate before it continues or commits, insert a type=human decision stage (references/format.md); never invent a model stage that pretends to approve.
  • Choose per item: a logic, server or format change usually wants the planner (a plan/implement/review pipeline); a small, fully understood tweak may use the leaner implementer-first variant. Both keep all review stages.

Running and watching

  • Launch with the authoritative CLI_PREFIX (pipelines run). The brief text is the run's task; pass it whole. Read references/operations.md for the exact flags — --json, confirmation (--yes) and --wait/--wait-timeout.
  • Model overrides at launch. Use --model PROVIDER/MODEL to override the model for every model stage of that run, and repeatable --stage-model STAGE=PROVIDER/MODEL to override individual stages. Precedence is per-stage > whole-run > the model pinned in the pipeline version. Overrides apply to that run only (the pinned pipeline is never edited), are validated before the run starts, and are recorded on the run; retry reuses them. See references/harnesses.md for how a stage's model and its repair path both use the effective model.
  • Watch to a terminal state (succeeded, failed, canceled, interrupted). Poll CLI_PREFIX inspect RUN_ID --json (or use --wait) until terminal. A reached client wait limit is not a run failure: the run stays active; keep waiting or reattach with the original request key, never start a duplicate run.
  • Read the outcomes, not just the status: the option each stage returned, the evidence it recorded, and any run or step diagnostic. Interpret diagnostics by category (references/debugging.md).
  • Retry once, then record and continue. Retry a failed or interrupted item at most once. If it fails again, record the brief as failed and move to the next item; never loop or start duplicates to force a pass.
  • Stop the chain on failure and verify by hand. Do not push the next item on top of a broken tree. Inspect the failure, fix the pipeline or service cause, and verify the tree by hand before continuing. Report the failure; never hide it by re-running until something passes.

What the operator reviews

From the run record alone, the operator must be able to see: the brief, the changed files and diff, the reviewer's exact commands and observed results, the screenshots the visual reviewer read, and the commit. Produce those, and say plainly what was not tested (references/verification.md).