Add a documentation page
A focused docs page with a length budget — not a 3,000-word essay.
Docs tasks fail when they're open-ended. 'Document the sandbox' is a prompt the agent will happily turn into a wall of marketing prose. This template caps the word count, lists the required sections, and anchors the new page to an existing one as a structural template.
When to reach for this template.
- You can name an existing docs page to copy the structure from.
- You can list the required sections in order.
- You're willing to set a word-count budget (and let the agent enforce it).
- The task ships markdown only — no code changes, no new dependencies.
The template.
Drop this into .watchfire/tasks/<n>.yaml, edit the prompt and acceptance_criteria to match your repo, and let the daemon run it.
task_id: docs0006
task_number: 6
title: "Add docs page: /docs/concepts/sandboxing"
prompt: |
Add a new docs page at
`content/docs/concepts/sandboxing.mdx` that
explains how Watchfire isolates each agent with
`sandbox-exec` on macOS. Use
`content/docs/concepts/worktrees.mdx` as the
structural template — same frontmatter shape,
same heading depth, same voice.
Sections, in order:
1. _Why a sandbox?_ — one paragraph on what
could go wrong without one.
2. _What the policy allows_ — bullet list:
read most of the filesystem, write to
project/temp dirs, full network.
3. _What the policy blocks_ — bullet list:
`~/.ssh`, `~/.aws`, `~/.gnupg`,
`~/Desktop`, `~/Documents`, `~/Downloads`,
`.env`, `.git/hooks`.
4. _Turning it off_ — short, with a clear
warning.
Target length: 600–900 words. No new
illustrations. No new dependencies. Register
the page in `content/docs/concepts/meta.json`
in the correct position.
acceptance_criteria: |
- `content/docs/concepts/sandboxing.mdx` exists
with the four sections above, in order.
- The page is registered in
`content/docs/concepts/meta.json`.
- Word count is between 600 and 900 (rough
`wc -w` is fine).
- `npm run build` passes; the page renders at
`/docs/concepts/sandboxing`.
- `npm run lint` passes.
- No code changes outside `content/docs/`.
status: ready
Common pitfalls.
The shapes of failure most often seen on this kind of task — and the way this template hedges against each.
- No length cap. The agent will pad — three paragraphs become eight, and the docs page becomes the longest one in the site without saying much more.
- No structural template. The agent invents a new frontmatter shape and the docs registry quietly stops indexing the page.
- Letting marketing prose creep in. Docs that read like a landing page are docs nobody trusts; require concrete examples and links to source.
- Forgetting the navigation registration. New docs pages need to be linked into a `meta.json` or sidebar — make it an acceptance criterion or the page becomes unreachable.
Related templates.
Add a small feature
One capability you can describe in a sentence — with a list of what it isn't.
Open the template
Investigate and report (no code changes)
Diagnosis only — the artifact is a Markdown report, not a patch.
Open the template
Add tests for an untested module
Backfill coverage against a named bar — not the agent's idea of 'enough tests'.
Open the template
Pair it with a playbook.
These use-case playbooks lean on tasks shaped like this one.
Build your own.
This template is a starting point. Fill in a form to draft your own task in the playground — or read the full task schema to learn every field the daemon understands.
Get started with Watchfire
Install in seconds. Define tasks. Let agents ship code for you.
Download for macOSAvailable for macOS, Linux, and Windows
# Install via Homebrew (macOS)brew tap watchfire-io/tapbrew install --cask watchfire-io/tap/watchfire# Set up your project and gowatchfire initwatchfire task add "Build the login page"watchfire start --allIncludes GUI, CLI, and daemon. Also available via Homebrew.