Back to Plate

{{TITLE}}

.agents/skills/autogoal/assets/templates/docs.md

53.0.82.4 KB
Original Source

{{TITLE}}

Objective: TODO: Write the short create_goal objective, under 240 characters. Put the full docs contract in the sections below.

Goal plan: {{PLAN_PATH}}

Template: {{TEMPLATE_PATH}}

Docs source:

  • type: pending
  • id / link: pending
  • title: pending
  • acceptance criteria: pending

Completion threshold:

  • TODO: Define the exact docs done state.

Verification surface:

  • TODO: Name source audit, docs parser/build, link/demo check, preview check, or review proof.

Constraints:

  • Follow nearest existing docs style.
  • Write current-state docs only. No changelog voice.
  • Keep examples repo-backed and copy-pasteable.
  • Do not invent APIs, routes, demos, imports, components, transforms, or options.

Boundaries:

  • Source of truth: TODO.
  • Allowed edit scope: TODO.
  • Browser surface: TODO.
  • Non-goals: TODO.

Blocked condition:

  • TODO: Name missing source code, docs entry, route, product choice, or command failure that stops autonomous docs work.

Completion rule:

  • Do not call update_goal(status: complete) until required checks are closed and node .agents/skills/autogoal/scripts/check-complete.mjs {{PLAN_PATH}} passes.

Start Gates:

GateAppliesEvidence
Active goal checked or createdpendingpending
Target docs readpendingpending
Nearest sibling docs readpendingpending
Documented source code readpendingpending

Work Checklist:

  • Target docs and nearest sibling docs were read before writing.
  • Documented behavior or API was verified against current source.
  • Fastest success path appears before deeper mechanics or API reference.
  • Named APIs, imports, routes, options, and examples are exact and current.
  • Links and anchors target real pages or are marked N/A.

Completion Gates:

GateAppliesRequired actionEvidence
Docs source-backed claim auditpendingVerify docs claims against current sourcepending
Docs links / routes / previewspendingVerify or record N/Apending
Docs parser/buildpendingRun relevant docs parser/build or record N/Apending
AutoreviewpendingReview final docs against objective, constraints, source truth, and newest user requestpending
Goal plan completeyesRun node .agents/skills/autogoal/scripts/check-complete.mjs {{PLAN_PATH}}pending

Findings:

  • None yet.

Timeline:

  • {{CREATED_AT}}: plan created.