docs: Update checkpoint system docs for v2 [doc-updater] - #648
Conversation
Update documentation to reflect checkpoint v2 changes from #643. Key updates: - docs/architecture/README.md: Expand checkpoint section to describe v2 features (session-end capture, trigger types, multi-dimensional querying, all CLI filter options) - docs/development/STRUCTURE.md: Update checkpoint_handler.py comment to reflect both commit and session-end triggers Checkpoint v2 introduced session-end capture (completed/expired/failed status), rich querying (by issue, PR, session, agent type, phase, trigger, status), and multi-dimensional indexing. The docs now accurately describe these capabilities. Triggered by: #643 Authored-by: egg
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Documentation Review
Verified all documentation claims against the codebase. The content is accurate — triggers, session statuses, CLI commands, filter options, captured data fields, and branch references all match the implementation.
Two minor issues:
1. Escaped pipes inside backtick code spans (lines 114-117 of docs/architecture/README.md)
The filter value examples use \| (backslash-pipe) inside backtick code spans:
`--trigger <commit\|session_end>`
Inside backtick code spans, markdown does not interpret pipe characters, so the backslash renders literally as a visible \ character. The rendered output will show commit\|session_end instead of the intended commit|session_end. The backslash escaping is only needed inside table cells, not in code spans or bullet lists. Remove the backslashes.
2. Missing unknown agent type (line 116)
The --agent-type filter lists coder|tester|documenter|integrator|reviewer, but the AgentType enum in shared/egg_contracts/checkpoints.py:162 also defines UNKNOWN = "unknown". While users are unlikely to filter by unknown, the documentation should either include it for completeness or note that it's omitted intentionally.
Neither issue is blocking. The documentation is otherwise accurate, well-structured, and covers the v2 changes comprehensively.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Remove unnecessary backslash escaping of pipe characters inside backtick code spans where markdown doesn't interpret pipes. Add missing 'unknown' value to --agent-type filter documentation to match the AgentType enum.
|
Both issues addressed in e34765c:
— Authored by egg |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Re-review of e34765c
Both issues from the previous review are properly fixed:
- Escaped pipes: All four
\|sequences in code spans replaced with|. Verified they render correctly. - Missing
unknownagent type: Added to--agent-typefilter values. Verified all enum values in docs match the source (TriggerType,SessionStatus,AgentTypeinshared/egg_contracts/checkpoints.py,PipelinePhaseinshared/egg_contracts/models.py).
No new issues introduced.
— Authored by egg
There was a problem hiding this comment.
No agent-mode design concerns. The delta since last review (e34765c) addresses previous review feedback — fixing escaped pipes in code spans and adding the missing unknown agent type. Documentation-only changes with no impact on agent workflows.
— Authored by egg
|
egg review completed. View run logs 4 previous review(s) hidden. |
|
egg agent-mode-design completed. View run logs 4 previous review(s) hidden. |
Summary
Update documentation to reflect checkpoint v2 changes from #643.
Changes made:
docs/architecture/README.md:
docs/development/STRUCTURE.md:
Why these updates were needed:
Checkpoint v2 introduced significant new capabilities:
The previous docs only described commit-based checkpoints with basic filtering. They didn't mention session-end capture or the rich query capabilities that are now available.
Triggered by: #643
Authored-by: egg