Skip to content

docs: route agent guidance by task#1213

Draft
mariusvniekerk wants to merge 7 commits into
mainfrom
docs/agent-guidance-restructure
Draft

docs: route agent guidance by task#1213
mariusvniekerk wants to merge 7 commits into
mainfrom
docs/agent-guidance-restructure

Conversation

@mariusvniekerk

Copy link
Copy Markdown
Collaborator

The root AGENTS.md had grown into an always-loaded mix of repository policy, subsystem contracts, command reference, and troubleshooting history. That made the rules that apply to every task harder to find and allowed copied documentation to drift.

This change keeps safety, delivery, completion, and publishing rules in the root file, then routes storage, testing, frontend, build, and background-work tasks to focused guides. It also corrects the stale DuckDB schema-lifecycle note found during the split. The main tradeoff is that agents must follow the routing table before editing a matching part of the repository; the root keeps the critical SQLite preservation warning as a safeguard.

generated by a clanker

@roborev-ci

roborev-ci Bot commented Jul 21, 2026

Copy link
Copy Markdown

roborev: Combined Review (f433a1e)

Documentation refactor has one medium-severity guidance regression.

Medium

  • AGENTS.md:17 — The testing guide is routed only for tasks already involving tests, so feature and bug-fix work may not read its unit-test requirement. Expand the route to cover new features and bug fixes, or retain the unit-test requirement in the root guide.

Reviewers: 2 done | Synthesis: codex, 8s | Total: 2m5s

The root agent file has accumulated subsystem notes, project reference material, and repeated rules that load for every task. Record the approved split before moving content so each later commit has a clear placement rule and can be reviewed or reverted on its own.
The guidance split spans several independently useful edits. Record the file boundaries and document-only checks so each extraction can land as a small commit without adding tests or changing runtime behavior.
Testing and localization rules apply only when those parts of the project change. Give them focused homes so the root instructions can route relevant tasks without loading this detail for unrelated work.
Storage work carries data-loss and backend-parity constraints that do not apply to most tasks. Keep those rules together so the root file can route storage changes to one precise contract.
Memory investigations and build troubleshooting need precise constraints, but those constraints distract from ordinary tasks. Move them into focused guides that the root file can load by route.
The root instructions loaded subsystem contracts and reference catalogues for every task, which hid the repository-wide rules. Keep the root focused on safety, delivery, completion, and explicit routes to the new guides.
The package README still described additive in-place migration after the mirror moved to rebuild-and-swap schema changes. Align the package description with the current disposable-mirror contract.
@mariusvniekerk
mariusvniekerk force-pushed the docs/agent-guidance-restructure branch from f433a1e to 7d16fb1 Compare July 22, 2026 15:50
@roborev-ci

roborev-ci Bot commented Jul 22, 2026

Copy link
Copy Markdown

roborev: Combined Review (7d16fb1)

Documentation routing has two medium-severity gaps that could cause required testing or resync work to be missed.

Medium

  • AGENTS.md:17, docs/agents/testing.md:7 — The testing guide is routed only for tasks already involving tests, but the requirement to add tests for every feature or bug fix exists only within that guide. Production-code changes may therefore miss the requirement. Route new features and bug fixes to docs/agents/testing.md, or retain the coverage requirement in the root guide.

  • AGENTS.md:18, docs/agents/storage.md:11 — Parser changes do not trigger the storage guide unless the agent already recognizes that a resync is required. Changes affecting persisted parser output may miss the data-version/full-resync requirement, leaving historical sessions stale. Route persisted parser or session-format changes to the storage guide, and explicitly require a data-version bump and full resync when stored output changes.


Reviewers: 2 done | Synthesis: codex, 8s | Total: 2m20s

@roborev-ci

roborev-ci Bot commented Jul 24, 2026

Copy link
Copy Markdown

roborev: Combined Review (7d16fb1)

Documentation refactor is generally sound, but one medium-severity routing gap could hide the unit-test requirement.

Medium

  • AGENTS.md:15 — The testing guide is routed only for tasks explicitly involving tests or test helpers. Agents implementing features or bug fixes may not read the moved requirement to add unit tests, so the refactor does not fully preserve the rule. Expand the route to include feature and bug-fix work, or retain the unit-test requirement in the root definition of done.

Reviewers: 2 done | Synthesis: codex, 7s | Total: 59s

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant