docs: update documenter purpose to snapshot framing [doc-updater] - #3324
Conversation
This comment has been minimized.
This comment has been minimized.
Autofix tracking{"Lint/Python": 1, "Test/Unit Tests": 1} |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Review: docs update for documenter snapshot framing
I verified every claim in the PR against the source. The three documented changes are accurate:
shared/egg_contracts/agent_roles.py:308—description="Documents the current state of the code"✓ (matches the updateddocs/reference/agent-roles.mdPurpose line)orchestrator/routes/pipelines.py:6763—_build_role_context()documenter branch emits "Document the current state of the code in the areas these tasks touch…" ✓ (matches the updated quote indocs/guides/agent-development.md)- The
pipelines.pyhunk in the second commit ("Fix checks: apply automated formatting fixes") is a pure quote-style change — escaped\"…\"inside double-quoted strings rewritten as single-quoted strings. String contents are byte-identical; no behavior change. ✓
No test pins any of the affected strings, so nothing regresses.
The reframe is applied incompletely — two stale references remain
The PR's goal is to make the docs reflect the snapshot-not-ledger framing. But the same old "Updates documentation for changes" wording — the exact changelog connotation #3288 set out to remove — still survives in two places:
1. orchestrator/routes/pipelines.py:13623 (same file this PR edits) — should fix here.
"documenter": (
"Updates documentation for changes",
"doc files, README updates, inline documentation",
),This _ROLE_DESCRIPTIONS entry is rendered by _build_agent_roster() (line 13688) into the "Active Agents in This Phase" roster injected into every agent's prompt. The result is that the documenter's own prompt now contains a direct contradiction: the phase-scope block says "Document the current state of the code … not a log of what changed" (line 6763), while the roster block describes the documenter as one who "Updates documentation for changes." Since this string is in the file the PR is already modifying and embodies the precise framing being retired, it should be updated in the same change — e.g. "Documents the current state of the code" to match agent_roles.py:308.
2. docs/guides/sdlc-pipeline.md:633 (non-blocking) — terse table cell still reads:
| **Documenter** | Execution | Updates documentation | … |
Lower priority since it's a one-word summary in a different doc, but for the reframe to be coherent across the docs it should track the new Purpose ("Documents the current state of the code"). Worth folding in while touching documenter framing.
Summary
The changes made are correct. Finding #1 is a same-file inconsistency that leaves the documenter's generated prompt internally contradictory and is squarely within the PR's stated scope; please update _ROLE_DESCRIPTIONS["documenter"] in this PR. Finding #2 is a non-blocking consistency suggestion.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Review feedback addressedThanks for verifying the changes against source. Both findings addressed in commit 1. 2.
— Authored by egg |
This comment has been minimized.
This comment has been minimized.
|
egg is investigating the Test check failure...
|
Check Failure: Test / Unit TestsWhat's failing: Two doc-terminology regression tests in
Root cause — pre-existing on The de-ledger initiative #3288 (commit What needs to be done (out of scope for this documenter-snapshot PR, and
Suggestion: Fix this on — Authored by egg |
|
egg check fixer completed for Test. CI will re-run to verify. View run logs — Authored by egg |
Update documenter role docs to reflect snapshot-not-ledger framing from #3288.
shared/egg_contracts/agent_roles.pychanged the documenter descriptionfrom "Updates documentation for the changes" to "Documents the current
state of the code", and the responsibilities now emphasize writing
snapshots rather than changelogs. Two docs referenced the old framing:
docs/reference/agent-roles.md:**Purpose**line updated to match the new description.docs/guides/agent-development.md: Quoted example phrase updated to match the new_build_role_context()instruction.Triggered by: #3318
Issue: none
Test Plan
agent_roles.pyandpipelines.pyAuthored-by: egg