Back to Plate

rewrite performance docs

docs/plans/2026-06-02-rewrite-performance-docs.md

53.0.87.9 KB
Original Source

rewrite performance docs

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

Goal plan: docs/plans/2026-06-02-rewrite-performance-docs.md

Template: docs/plans/templates/docs.md

Primary template: docs/plans/templates/docs.md

Applied packs:

  • none

Docs source:

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

Docs lane:

  • lane: pending
  • target docs: pending
  • documented source owner: pending
  • nearest sibling docs: pending
  • plugin page: pending

Completion threshold:

  • TODO: Define the exact docs done state.
  • Docs closure is legal only when the page teaches the fastest correct path, every claim is source-backed, docs-lane shape is satisfied, required MDX/link/ preview checks are recorded, and node .agents/skills/autogoal/scripts/check-complete.mjs docs/plans/2026-06-02-rewrite-performance-docs.md passes.

Verification surface:

  • TODO: Name the source audit, docs render/parser command, link/demo check, content build, or review proof that proves the threshold.

Constraints:

  • Follow .agents/rules/docs-creator.mdc for docs style and workflow.
  • Write current-state docs only. No changelog voice.
  • Keep code examples repo-backed and copy-pasteable.
  • Do not invent APIs, routes, demos, imports, components, transforms, or options.
  • Do not add docs ceremony for tiny typo/copy edits.

Boundaries:

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

Blocked condition:

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

Docs state:

  • task_type: docs
  • task_complexity: pending
  • current_phase: intake
  • current_phase_status: in_progress
  • next_phase: writing
  • goal_status: active

Current verdict:

  • verdict: pending
  • confidence: pending
  • next owner: docs
  • reason: pending

Completion rule:

  • Do not call update_goal(status: complete) while any required checklist item remains unchecked. If an item does not apply, check it and add N/A: <reason>.
  • Do not call update_goal(status: complete) until every completion threshold above is satisfied, final evidence is recorded, and node .agents/skills/autogoal/scripts/check-complete.mjs docs/plans/2026-06-02-rewrite-performance-docs.md passes.
  • Do not create hook state for this goal. This file plus the active goal are the durable state.

Start Gates:

GateAppliesEvidence
docs-creator loadedpendingpending
Active goal checked or createdpendingpending
Docs lane selectedpendingpending
Target docs readpendingpending
Nearest sibling docs readpendingpending
Docs style doctrine readpendingpending
Documented source code readpendingpending
Ownership map draftedpendingpending
Plugin-page rules decisionpendingpending
Browser/render proof decisionpendingpending
PR/tracker expectation decisionpendingpending

Work Checklist:

  • Short objective plus outcome, completion threshold, verification surface, constraints, boundaries, and blocked condition are concrete.
  • Docs lane is classified as install, guide/system, plugin/feature, serialization/conversion, workflow/AI, API reference, or spec/law.
  • Target docs and nearest sibling docs were read before writing.
  • Docs style doctrine in docs-creator was read before writing.
  • Documented behavior or API was verified against current source.
  • Ownership map records core runtime, package, kit, registry, and app-local ownership where relevant.
  • Fastest success path appears before deeper mechanics or API reference.
  • Opening is three sentences or fewer and avoids generic fluff.
  • Named APIs, options, transforms, components, imports, routes, and package specifiers are exact and current.
  • Plugin docs, if applicable, satisfy kit/manual/API ordering and headless package ownership.
  • Serialization docs, if applicable, split directions and state environment constraints before examples.
  • API reference docs, if applicable, use exact contracts and avoid tutorial filler.
  • Spec/law docs, if applicable, record owner map, evidence, and explicit gaps.
  • Demos/previews are real registry entries or marked N/A with reason.
  • Links target real leaf pages and do not reinforce pages being displaced.
  • Anti-slop audit passed: no changelog voice, no fake APIs, no placeholder comments, no TODOs, no dead anchors, no redundant summary section.
  • Workspace authority recorded: every proof command names the cwd/tool that owns the changed docs.
  • Review/autoreview target selected for non-trivial docs work, or marked N/A with reason.

Completion Gates:

GateAppliesRequired actionEvidence
Named verification thresholdpendingRun the source audit, parser/build, link/demo check, or review named in this planpending
Docs lane shape satisfiedpendingCheck the lane-specific structure against docs-creatorpending
Source-backed claim auditpendingVerify every named API/option/transform/component/import/route against sourcepending
Ownership map verifiedpendingConfirm package/layer/kit/app-local ownership claims against sourcepending
MDX/content parserpendingRun pnpm --filter www build:contentlayer for MDX/content changes, or record N/Apending
Links/routes/previews verifiedpendingCheck leaf links, routes, anchors, and <ComponentPreview> names or record N/Apending
Plugin page specificspendingIf plugin page, apply docs-creator kit/manual/API rules or record N/Apending
Browser/render surface changedpendingCapture Browser Use proof or record explicit waiver/blockerpending
Package/API behavior changedpendingAdd changeset or record N/Apending
Agent rules or skills changedpendingRun pnpm install and verify generated skill syncpending
Autoreview for non-trivial docs changespendingLoad .agents/skills/autoreview/SKILL.md and run the right target, or record N/A for tiny/no-local-patch workpending
Final lintpendingRun pnpm lint:fix or scoped equivalentpending
Goal plan completeyesRun node .agents/skills/autogoal/scripts/check-complete.mjs docs/plans/2026-06-02-rewrite-performance-docs.mdpending

Phase / pass table:

PhaseStatusEvidenceNext
Intake and source readin_progresscreated planwriting
Writingpendingverification
Verificationpendingcloseout
PR / tracker syncpendingfinal response
Closeoutpendingfinal response

Findings:

  • None yet.

Decisions and tradeoffs:

  • None yet.

Implementation notes:

  • None yet.

Review fixes:

  • None yet.

Error attempts:

Error / failed attemptCountNext different moveResolution
None yet0

Verification evidence:

  • Pending.

Final handoff contract:

  • PR line: pending
  • Issue / tracker line: pending
  • Confidence line: pending
  • Docs lane: pending
  • Source-backed claims: pending
  • Content build / parser: pending
  • Links / demos / previews: pending
  • Browser check: pending
  • Outcome: pending
  • Caveat: pending
  • Verified: pending

Final handoff / sync:

  • PR: pending
  • Issue / tracker: pending
  • Browser proof: pending
  • Caveats: pending

Timeline:

  • 2026-06-02T18:03:05.662Z Docs goal plan created.

Reboot status:

QuestionAnswer
Where am I?Intake and source read
Where am I going?Writing, verification, closeout
What is the goal?TODO: Fill from Objective
What have I learned?See Findings
What have I done?See Timeline

Open risks:

  • Pending.