docs: Update STRUCTURE.md for checkpoint infrastructure [doc-updater] - #520
Conversation
Update project structure documentation to reflect checkpoint-related components added in PR #517 (per-commit checkpoints + API proxy transcript capture): Gateway additions: - checkpoint_handler.py: Per-commit checkpoint capture - transcript_buffer.py: API proxy transcript capture buffer Sandbox additions: - egg-checkpoint CLI symlink in bin/ - checkpoint_cli.py wrapper in egg_lib/ Shared library additions: - checkpoints.py: Checkpoint data models - checkpoint_loader.py: Checkpoint storage and retrieval - checkpoint_cli.py: Checkpoint browsing CLI implementation - transcript_extractor.py: API transcript extraction Triggered by: c7fb529 (#517) Authored-by: egg
![james-in-a-box[bot]](https://avatars.githubusercontent.com/u/8340608?s=60&v=4){kind=small}
There was a problem hiding this comment.
Documentation Review
Reviewed PR #520, which updates STRUCTURE.md to document checkpoint infrastructure added in #517.
Verification Performed
Files exist:
- ✓
gateway/checkpoint_handler.py- 29KB - ✓
gateway/transcript_buffer.py- 18KB - ✓
sandbox/bin/egg-checkpoint- symlink to../egg_lib/checkpoint_cli.py - ✓
sandbox/egg_lib/checkpoint_cli.py- wrapper that re-exports from shared - ✓
shared/egg_contracts/checkpoints.py- Pydantic models - ✓
shared/egg_contracts/checkpoint_loader.py- storage/retrieval - ✓
shared/egg_contracts/checkpoint_cli.py- CLI implementation - ✓
shared/egg_contracts/transcript_extractor.py- API transcript extraction
Descriptions accurate:
Cross-referenced docstrings against documentation:
checkpoint_handler.py: Docstring confirms "per-commit checkpoint capture" ✓transcript_buffer.py: Docstring confirms "API proxy transcript capture buffer" ✓checkpoints.py: Docstring confirms "Pydantic models for agent checkpoint data" ✓checkpoint_loader.py: Docstring confirms "checkpoint storage and retrieval" ✓checkpoint_cli.py(shared): Docstring confirms "browsing and querying agent checkpoints" ✓transcript_extractor.py: Docstring confirms "API transcript extraction" ✓
Directory structure:
The added entries maintain alphabetical ordering within each directory section, consistent with existing formatting conventions.
Minor Note (non-blocking)
The PR description mentions checkpoint_handler.py as "modified from existing" and transcript_buffer.py as "new", which aligns with PR #517's file changes (additions:262,deletions:20 vs additions:525,deletions:0). The documentation doesn't annotate whether files are new vs modified, which is appropriate—STRUCTURE.md documents current state, not change history.
No issues found.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
| egg is addressing review feedback... |
|
egg feedback addressed. View run logs 1 previous review(s) hidden. |
1 participant
Update project structure documentation to reflect checkpoint-related components added in PR #517.
PR #517 introduced per-commit checkpoint capture and API proxy transcript buffers, adding several new files across the gateway, sandbox, and shared libraries. This PR updates STRUCTURE.md to document these new components:
Gateway additions:
checkpoint_handler.py: Per-commit checkpoint capture (modified from existing)transcript_buffer.py: API proxy transcript capture buffer (new)Sandbox additions:
egg-checkpointCLI symlink inbin/checkpoint_cli.pywrapper inegg_lib/Shared library additions:
checkpoints.py: Checkpoint data modelscheckpoint_loader.py: Checkpoint storage and retrievalcheckpoint_cli.py: Checkpoint browsing CLI implementationtranscript_extractor.py: API transcript extraction (modified from existing)These updates ensure the project structure documentation accurately reflects the current codebase.
Triggered by: c7fb529 (#517)
Authored-by: egg