Back to Plate

consolidate slate v2 agent docs

docs/plans/2026-05-30-consolidate-slate-v2-agent-docs.md

53.0.820.8 KB
Original Source

consolidate slate v2 agent docs

Objective: One-shot execution: consolidate Slate v2 agent-facing docs and workflow rules for the already-large 4k-prompt development history.

Goal plan: docs/plans/2026-05-30-consolidate-slate-v2-agent-docs.md

Template: docs/plans/templates/task.md

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

Applied packs:

  • docs (docs/plans/templates/packs/docs.md)
  • agent-native (docs/plans/templates/packs/agent-native.md)

Task source:

  • type: user request
  • id / link: current Codex thread, 2026-05-30
  • title: Consolidate Slate v2 agent docs and workflow modes
  • acceptance criteria:
    • add docs/slate-v2/agent-start.md with <=120 lines
    • make docs/slate-v2 entrypoints prefer summaries/indexes over giant ledgers
    • update stale current API snippets in Slate v2 docs
    • keep slate-patch mostly intact
    • split slate-plan rule behavior into --quick, --standard, and --deep
    • add a repeatable doc-audit check for stale Slate v2 API snippets
    • sync generated skills after .agents/rules/** edits

Completion threshold:

  • Done when all acceptance criteria above are implemented, stale-doc audit passes, generated skills are synced, focused source audits prove the intended entrypoints/rules exist, and node .agents/rules/autogoal/scripts/check-complete.mjs docs/plans/2026-05-30-consolidate-slate-v2-agent-docs.md passes.

Verification surface:

  • node tooling/scripts/check-slate-v2-docs.mjs
  • pnpm install
  • pnpm lint:fix
  • source audits for agent-start, slate-plan modes, generated skill sync, and stale API snippet cleanup
  • goal-plan mechanical closeout check

Constraints:

  • Preserve existing user-facing behavior outside the task scope.
  • Prefer the durable ownership boundary over caller-by-caller patches.
  • Do not create PRs, comments, commits, or pushes unless the task/user/skill requires them.
  • Do not add broad ceremony when the task is trivial or docs-only.

Boundaries:

  • Source of truth: .agents/rules/*.mdc, docs/slate-v2/**, tooling/scripts/**, package.json, and the generated .agents/skills/** mirrors after pnpm install.
  • Allowed edit scope: agent-facing docs/rules/scripts/package scripts and this goal plan.
  • Browser surface: N/A, no UI/runtime route behavior changed.
  • Tracker sync: N/A, no issue/Linear/PR requested.
  • Non-goals: do not touch .tmp/slate-v2 implementation; do not split giant ledgers physically unless references require it; do not rewrite slate-patch.

Blocked condition:

  • Block only if pnpm install cannot regenerate skills, the doc-audit cannot be made deterministic from current public-surface contracts, or a required source file is unavailable.

Task state:

  • task_type: docs + agent-native workflow cleanup
  • task_complexity: normal
  • current_phase: intake
  • current_phase_status: complete
  • next_phase: implementation
  • goal_status: active

Current verdict:

  • verdict: implement
  • confidence: high
  • next owner: task
  • reason: current docs/rules are useful but too large for frequent 4k-prompt agent loops; a thin entrypoint and mode split reduce review bandwidth without weakening deep gates.

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 handoff evidence is recorded, and node .agents/rules/autogoal/scripts/check-complete.mjs docs/plans/2026-05-30-consolidate-slate-v2-agent-docs.md passes.
  • Do not create hook state for this goal. This file plus the active goal are the durable state.

Start Gates:

GateAppliesEvidence
Skill analysis before editsyesused autogoal; reviewed pasted slate-plan/slate-patch context and loaded agent-native-reviewer for agent-facing changes
Active goal checked or createdyesget_goal returned no active goal; create_goal created this lane
Source of truth read before editsyesread docs/slate-v2/overview.md, master-roadmap.md, ledgers/README.md, absolute-architecture-release-claim.md, .agents/rules/slate-plan.mdc, .agents/rules/slate-patch.mdc, package scripts, and live .tmp/slate-v2 public API/test snippets
Tracker comments and attachments readyesuser provided pasted orchestration-tax text and explicit acceptance criteria
Video transcript evidence requirednoN/A: no video/browser repro in this task
docs/solutions checked for non-trivial existing-code worknoN/A: docs/agent workflow cleanup, no product code implementation
TDD decision before behavior change or bug fixnoN/A: no Slate runtime behavior changed; doc-audit script gets direct command proof
Branch decision for code-changing tasknoN/A: user did not request branch/PR
Release artifact decisionnoN/A: no package release behavior changed
Browser tool decision for browser surfacenoN/A: no browser surface changed
PR expectation decisionnoN/A: no PR requested
Tracker sync expectation decisionnoN/A: no tracker sync requested
Docs pack selectedyesdocs pack applied to this plan
docs-creator loadednoN/A: internal agent docs, not Plate public docs lane
Docs lane selectedyesinternal Slate v2 agent docs consolidation
Target docs and nearest sibling docs readyesread Slate v2 overview, roadmap, ledgers README, release claim, architecture contract snippets
Docs style doctrine readyesAGENTS docs current-state rule read in prompt
Documented source owner identifiedyescurrent API owner is .tmp/slate-v2/packages/slate/test/public-surface-contract.ts plus live docs/examples
Agent-native pack selectedyesagent-native pack applied to this plan
Agent-facing action surface identifiedyes.agents/rules/slate-plan.mdc, generated .agents/skills/slate-plan/SKILL.md, docs/slate-v2/agent-start.md
Source rule versus generated mirror boundary identifiedyesedit .agents/rules/*.mdc, then run pnpm install; do not hand-edit generated skills
agent-native-reviewer loaded or waiver recordedyesloaded .agents/skills/agent-native-reviewer/SKILL.md; no accepted/actionable findings for this agent-facing docs/rule cleanup

Work Checklist:

  • Objective includes outcome, completion threshold, verification surface, constraints, boundaries, and blocked condition.
  • Task source classified with source type, id/link, title, task type, acceptance criteria, caveats, likely files/routes/packages, browser surface, and root-cause layer.
  • Required video or screen-recording evidence is cached/read as normalized <video-transcripts> XML, or marked N/A with reason.
  • Nearby repo instructions and implementation patterns read before edits.
  • Implementation fixes the right ownership boundary, or the narrower choice is recorded with reason.
  • Release artifact requirement recorded: changeset, registry changelog, or N/A with reason.
  • Final handoff shape decided: bug/feature/testing/batch/review/tracker requirements, PR body sync, and issue/Linear sync when applicable.
  • Branch handling recorded for code-changing work: dedicated branch used, new branch needed, or N/A with reason.
  • Local-env-rot retry policy recorded for any surprising repo-wide failure: reinstall/rerun evidence or N/A with reason.
  • Workspace authority recorded: every proof command names the cwd/tool that owns the changed behavior.
  • High-risk note recorded for public API, runtime, package-boundary, browser behavior, agent-action, or command-contract changes, or marked N/A with reason.
  • Review/autoreview target selected from actual diff state for non-trivial implementation work, or marked N/A with reason.
  • Agent-native review decision recorded for .agents/**, .claude/**, .codex/**, skills, hooks, commands, prompts, or user-action tooling.
  • Docs pack: docs lane, target docs, nearest sibling docs, and source owner are recorded.
  • Docs pack: every named API, import, option, route, component, transform, demo, and preview is source-backed or marked N/A with reason.
  • Docs pack: docs use current-state reference voice, not changelog voice.
  • Docs pack: links, anchors, and previews target real leaf pages or are marked N/A with reason.
  • Agent-native pack: source-of-truth rule files are edited instead of generated skill mirrors.
  • Agent-native pack: the changed agent action is discoverable from the skill/rule text.
  • Agent-native pack: generated mirrors are synced when .agents/rules/** changed, or N/A reason is recorded.
  • Agent-native pack: accepted agent-native review findings are fixed or explicitly rejected with reason.

Completion Gates:

GateAppliesRequired actionEvidence
Named verification thresholdyesRun the command, proof, source audit, or artifact check named in this planpnpm docs:slate-v2:audit, pnpm install, pnpm lint:fix, source audits recorded below
Bug reproduced before fixnoRecord failing test/repro or N/A with reasonN/A: docs/agent workflow cleanup, not a runtime bug
Targeted behavior verificationyesRun focused test/proof for changed behavior or record N/Apnpm docs:slate-v2:audit proves stale API snippet cleanup; source audits prove mode split and indexes
TypeScript or typed config changednoRun relevant typecheckN/A: no TS typed config or package code changed; script syntax checked with node --check
Package exports or file layout changednoRun pnpm brl before final verification and keep generated barrel updatesN/A: no package exports or barrels changed
Package manifests, lockfile, or install graph changedyesRun pnpm install and relevant package checkspnpm install passed and regenerated skills through skiller
Agent rules or skills changedyesRun pnpm install and verify generated skill syncpnpm install passed; rg verified mode text in generated .agents/skills/slate-plan/SKILL.md
Workspace authority proofyesRun verification in the owning repo/package/app/route/tool and record cwd; do not count the wrong workspace as proofdocs/rules checks ran in plate-2; current API evidence read from .tmp/slate-v2 public-surface contract/source
Browser surface changednoCapture Browser Use proof or record explicit waiver/blockerN/A: no browser or UI runtime changed
Browser final proofnoAttach screenshot or exact browser verification caveat when browser proof appliesN/A: no browser surface changed
CI-controlled template output changednoRestore generated template output or record why it is intentionally keptN/A: no templates output changed
Package behavior or public API changednoAdd a changeset or record why no changeset appliesN/A: no published package behavior changed
Registry-only component work changednoUpdate docs/components/changelog.mdx or record N/AN/A: no registry component work
Docs or content changedyesFor docs-heavy work, use --template docs; for incidental docs, verify source-backed claims, links, examples, and rendered output or record N/Adocs pack applied; source-backed claims verified by pnpm docs:slate-v2:audit and source audits
High-risk mini gateyesFor public API/runtime/package-boundary/browser/agent-action/command-contract changes, record realistic failure mode, proof plan, and why the chosen boundary is right; otherwise N/ARisk: quick mode could under-review release-grade plans. Mitigation: standard/deep triggers retained for durable plans, release/API/collab/issue-risk lanes. Proof: generated skill contains trigger text.
Agent-native review for agent/tooling changesyesFor .agents/**, .claude/**, .codex/**, skills, hooks, commands, prompts, or user-action tooling, load .agents/skills/agent-native-reviewer/SKILL.md and close accepted/actionable findings, or record N/Aloaded reviewer skill; no accepted/actionable findings because changes are directly discoverable from generated skill and npm script
Local install corruption suspectednoRun pnpm run reinstall once, rerun the exact failing command, or record N/AN/A: no local-env-rot signal
Autoreview for non-trivial implementation changesnoLoad .agents/skills/autoreview/SKILL.md; use dirty local --mode local, branch/PR --mode branch --base <base>, or committed slice --mode commit --commit <ref> until no accepted/actionable findings, or record N/A for docs-only/trivial/no local patchN/A: docs/agent rule cleanup; agent-native review and mechanical audits are the correct closeout
PR create or updatenoRun check before PR work and sync PR body to final handoffN/A: no PR requested
PR proof image hostingnoIf PR body needs browser proof, replace local image paths with hosted GitHub URLs or record N/AN/A: no PR/browser proof images
Tracker sync-backnoPost concise issue/Linear sync after PR exists, or record N/A/blockerN/A: no tracker
Final handoff contractyesFill the final handoff fields below with exact PR/issue/confidence/tests/browser/outcome/caveats/design/verification content or N/A reasonfinal handoff fields completed below
Final lintyesRun pnpm lint:fix or scoped equivalentpnpm lint:fix passed, Biome fixed formatting
Goal plan completeyesRun node .agents/rules/autogoal/scripts/check-complete.mjs docs/plans/2026-05-30-consolidate-slate-v2-agent-docs.mdto run after this plan update
Docs source-backed claim audityesVerify docs claims against current source or record N/Apnpm docs:slate-v2:audit passed; stale old API grep returned no matches in release claim/architecture contract
Docs links / routes / previewsyesVerify leaf links, routes, anchors, and preview names or record N/Asource audit read overview and ledger README with new links; paths point to created files
Docs MDX/content parsernoRun pnpm --filter www build:contentlayer for MDX/content changes, or record N/AN/A: internal markdown docs outside www contentlayer
Plugin page specificsnoFor plugin pages, apply docs-creator kit/manual/API rules; otherwise N/AN/A: not plugin docs
Agent source / generated syncyesRun pnpm install when .agents/rules/** changed and verify generated mirrorspnpm install passed; generated .agents/skills/slate-plan/SKILL.md includes mode split
Agent action discoverabilityyesSource-audit the skill/rule path an agent will readrg found --quick, --standard, --deep, and orchestration-tax text in source and generated skill
Agent-native reviewyesLoad .agents/skills/agent-native-reviewer/SKILL.md and close accepted findings, or record N/Aloaded; no accepted/actionable findings

Phase / pass table:

PhaseStatusEvidenceNext
Intake and source readcompleteread user text, Slate v2 docs, current .tmp/slate-v2 public API surface, slate-plan/slate-patch rulesimplementation
Implementationcompleteadded agent-start, issue-dossier index, doc audit script, package script, stale API doc cleanup, slate-plan mode splitverification
Verificationcompleteaudit, install/sync, lint, source audits, script syntax checkcloseout
PR / tracker synccompleteN/A: no PR or tracker requestedfinal response
Closeoutcompletefinal plan update plus check-completefinal response

Findings:

  • The old docs were useful but too expensive for frequent agent work: docs/slate-v2/** had about 21k lines, with fork-issue-dossier.md at 7,864 lines.
  • absolute-architecture-release-claim.md and architecture-contract.md still taught stale editor.getSelection() / editor.getChildren() and direct editor write snippets while live .tmp/slate-v2 public examples and contracts teach editor.read((state) => ...) and editor.update((tx) => ...).
  • slate-patch already has the right shape for bug work: one-pass repro, behavior test, owner fix, pressure review, focused verification, autoreview.

Decisions and tradeoffs:

  • Add a thin agent-start.md instead of rewriting all long docs. This lowers cold-start cost without deleting evidence.
  • Keep giant dossiers but put them behind an index. Physical splitting can wait until a specific ledger edit needs it.
  • Make slate-plan --quick the default for lightweight architecture questions, while keeping --standard and --deep for durable/release-grade work.
  • Keep slate-patch unchanged except generated sync, because it already avoids Slate Plan ceremony for bug fixes.
  • Add a doc-audit script instead of relying on humans to remember the latest public-surface contract.

Implementation notes:

Review fixes:

  • None yet.

Error attempts:

Error / failed attemptCountNext different moveResolution
None yet0

Verification evidence:

  • pnpm docs:slate-v2:audit from plate-2: passed.
  • node --check tooling/scripts/check-slate-v2-docs.mjs from plate-2: passed.
  • wc -l docs/slate-v2/agent-start.md: 83 lines.
  • pnpm install from plate-2: passed; skiller regenerated agent skills.
  • rg "Mode Selection|--quick|--standard|--deep|orchestration tax" .agents/skills/slate-plan/SKILL.md: generated skill includes mode split.
  • rg "Slate Patch|Goal Setup|Do not create a Slate Plan pass schedule" .agents/skills/slate-patch/SKILL.md: slate-patch remains one-pass bug lane.
  • pnpm lint:fix from plate-2: passed.
  • rg 'editor\\.getSelection|editor\\.getChildren|editor\\.insertNodes|editor\\.setNodes|editor\\.moveNodes|editor\\.delete\\(' docs/slate-v2/absolute-architecture-release-claim.md docs/slate-v2/references/architecture-contract.md: no matches.

Final handoff contract:

  • PR line: N/A: no PR requested.
  • Issue / tracker line: N/A: no issue/tracker sync requested.
  • Confidence line: high; all named artifact checks passed.
  • Flow table:
    • Reproduced: N/A, docs/agent workflow cleanup.
    • Verified: docs audit passed, install/sync passed, lint passed, source audits passed.
  • Browser check: N/A, no browser surface changed.
  • Outcome: Slate v2 docs now have a short agent entrypoint, stale API snippets were updated, giant issue dossier is indexed, and Slate Plan has quick/standard/deep modes.
  • Caveat: giant ledgers were not physically split; they are indexed and demoted from first-read. Physical splitting should be a later ledger-maintenance task if it becomes useful.
  • Design:
    • Chosen boundary: docs/rules/scripts, not Slate runtime code.
    • Why not quick patch: stale docs and mode-selection pressure were systemic.
    • Why not broader change: deleting or physically splitting giant ledgers risks losing issue evidence; indexing gives the review-bandwidth win with lower risk.
  • Verified: commands listed in Verification evidence.

Final handoff / sync:

  • PR: N/A.
  • Issue / tracker: N/A.
  • Browser proof: N/A.
  • Caveats: giant ledgers remain as references, not first-read docs.

Timeline:

  • 2026-05-30T08:42:25.822Z Task goal plan created.
  • 2026-05-30T09:00Z Added agent entrypoint, issue index, docs audit script, stale API cleanup, and slate-plan mode split.
  • 2026-05-30T09:05Z Ran pnpm install, pnpm docs:slate-v2:audit, node --check, and pnpm lint:fix.

Reboot status:

QuestionAnswer
Where am I?Closeout
Where am I going?Final response after goal-plan check
What is the goal?Consolidate Slate v2 agent-facing docs/rules for low-orchestration 4k-prompt development
What have I learned?See Findings
What have I done?See Timeline and Implementation notes

Open risks:

  • Giant ledgers are still large; they are indexed, not physically split.