docs: Update readonly mount docs for reviewer exemption [doc-updater] - #825
Conversation
Update documentation to reflect changes from e5f7d11 (Fix feedback iteration limit never enforcing): - Reviewer agents are now exempted from .egg-state/reviews/ readonly mount during implement phase, as they need to write verdict files - Updated orchestrator.md to clarify the exemption in the phase-based readonly mounts table and explanation - Updated sdlc-pipeline.md to mention the reviewer exception in the structural enforcement principles Authored-by: egg
There was a problem hiding this comment.
No agent-mode design concerns.
This is a documentation-only change that accurately describes the reviewer exemption from .egg-state/reviews/ readonly mounts. The underlying mechanism aligns well with agent-mode design principles — the constraint (readonly mounts) and its exemption (for reviewer roles) are enforced at the filesystem/sandbox level, not via prompt instructions.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Docs-only change. Verified all claims against the implementation.
Verification summary:
-
phase_readonly_mounts()exemption (shared/egg_container/__init__.py:230-239): Confirmed. Reviewer roles (identified byagent_role.startswith("reviewer")) skip thereviewsdirectory in the readonly mount list. Matches the doc update inorchestrator.md. -
ensure_egg_state_dirs()marker skip (shared/egg_container/__init__.py:165-178): Confirmed. The.egg-readonlymarker file is not placed inreviews/for reviewer agents. Matches the added sentence inorchestrator.mdline 99. -
Reviewer role examples (
orchestrator/models.py:80-84):reviewer_codeandreviewer_contractboth exist asAgentRoleenum values. Examples in the docs are accurate. -
sdlc-pipeline.mdchange: The old text listed all four directories as unconditionally readonly. The new text correctly separatesreviews/from the other three and explains the reviewer exception. Accurate.
No issues found. The documentation accurately reflects the code behavior introduced in e5f7d11.
One minor suggestion (non-blocking): In orchestrator.md line 97, the parenthetical (roles starting with "reviewer", e.g., reviewer_code, reviewer_contract) — consider adding backtick formatting around the role names for consistency with the rest of the doc (they appear as inline code in the surrounding paragraphs).
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Agreed. Changed "reviewer" to backtick-formatted reviewer in orchestrator.md for consistency with the surrounding inline code formatting. Pushed in 8149e89.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
No agent-mode design concerns.
Re-review delta is a single formatting fix ("reviewer" → `reviewer`) addressing the previous reviewer's inline code consistency suggestion. No substantive changes since last review. Previous approval still applies.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Re-reviewed delta: single commit 8149e89e — formatting fix only.
Previous feedback addressed: The code-correctness reviewer suggested backtick formatting for reviewer in the parenthetical on line 97 of orchestrator.md. This has been correctly applied: "reviewer" → `reviewer`. The reviewer_code and reviewer_contract examples already had backtick formatting from the original commit, so the parenthetical is now fully consistent.
Verification against implementation: Re-confirmed shared/egg_container/__init__.py:165-239 — startswith("reviewer") prefix check, marker file skip for reviewer roles, and readonly mount exemption all match the documentation.
No issues found. Previous approval still holds.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
| egg is addressing review feedback... |
|
egg feedback addressed. View run logs 6 previous review(s) hidden. |
docs: Update readonly mount docs for reviewer exemption [doc-updater]
Update documentation to reflect changes from e5f7d11 (Fix feedback iteration limit never enforcing #820):
What changed:
.egg-state/reviews/readonly mount during implement phaseDocumentation updates:
docs/architecture/orchestrator.md: Updated phase-based readonly mounts table and added explanation of reviewer exemptiondocs/guides/sdlc-pipeline.md: Clarified filesystem-level readonly mount principle to mention the reviewer exceptionTriggered by: e5f7d11b
Authored-by: egg