Skip to content

docs: route agent guidance by task - #1213

Merged
wesm merged 1 commit into
mainfrom
docs/agent-guidance-restructure
Jul 31, 2026
Merged

docs: route agent guidance by task#1213
wesm merged 1 commit 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

@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

@mariusvniekerk
mariusvniekerk force-pushed the docs/agent-guidance-restructure branch from 7d16fb1 to ccff02e Compare July 27, 2026 17:50
@roborev-ci

roborev-ci Bot commented Jul 27, 2026

Copy link
Copy Markdown

roborev: Combined Review (ccff02e)

Documentation reorganization introduces two medium-risk guidance gaps.

Medium

  • AGENTS.md:17 — The unit-test requirement is only routed to agents already modifying tests or test helpers. Feature or bug-fix work may therefore omit required coverage. Include features and bug fixes in this route, or retain the mandatory coverage rule in the root guide.

  • AGENTS.md:18 — Parser changes are missing from the storage-guide route, despite that guide containing parser-resync and archive-preservation requirements. Route parser format/output and data-version changes through docs/agents/storage.md.


Reviewers: 2 done | Synthesis: codex, 6s | Total: 2m23s

@roborev-ci

roborev-ci Bot commented Jul 27, 2026

Copy link
Copy Markdown

roborev: Combined Review (7556789)

The documentation refactor has one medium-severity guidance-routing issue.

Medium

  • AGENTS.md:17 — The testing guide is routed only for test-file work, but it contains the requirement that every feature and bug fix receive unit tests. Agents changing production code may never read this requirement. Expand the route to cover feature and bug-fix work, or retain the unit-test requirement in the root guide.

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

@wesm
wesm marked this pull request as ready for review July 31, 2026 12:15
The root agent file had accumulated subsystem contracts and reference catalogues that obscured repository-wide rules. Route task-specific work to focused guides so agents load the constraints needed for the files and behavior they change.

- Plan the agent guidance refactor.
- Focus testing and frontend rules.
- Isolate storage guidance.
- Isolate operational guidance.
- Route agent guidance by task.
- Correct the DuckDB schema lifecycle.
- Remove completed planning artifacts.
- Route features and bug fixes through the testing guide.
@wesm
wesm force-pushed the docs/agent-guidance-restructure branch from 7556789 to 8205f63 Compare July 31, 2026 14:34
@roborev-ci

roborev-ci Bot commented Jul 31, 2026

Copy link
Copy Markdown

roborev: Combined Review (8205f63)

No issues found.


Reviewers: 2 done | Synthesis: codex | Total: 1m42s

@wesm
wesm merged commit b0318ad into main Jul 31, 2026
22 checks passed
@wesm
wesm deleted the docs/agent-guidance-restructure branch July 31, 2026 16:41
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.

2 participants