docs: fix Phase 1 subphase ordering and update sweep invocation#70
Merged
Conversation
…ADME - Fix Phase 1 subphase ordering: 1b=sandbox bootstrap, 1c=reconnaissance (prompts and code follow this order; README had them swapped) - Rewrite Phase 1 workflow section with three named subphases and CodeQL placement explanation - Update deep sweep section: document FILES=, EXCLUDE=, RESET=, auto-resume via tmp/sweep-state.txt, and aggregate sweep summary - Fix prompt filenames in prompts list (1b-recon→1b-sandbox, 1c-sandbox→1c-recon) - Add RESET=1 line to make help sweep section
📝 WalkthroughWalkthroughUpdates README workflow documentation and the Makefile help output to reflect Phase 1 sequencing, prompt names, and Deep Sweep controls. ChangesWorkflow documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
Greptile SummaryThis PR aligns the documentation with the current Phase 1 and sweep workflows.
Confidence Score: 5/5This looks safe to merge.
Important Files Changed
Reviews (1): Last reviewed commit: "docs: fix Phase 1 subphase ordering and ..." | Re-trigger Greptile |
Coverage Report
Generated by pytest-cov on |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 140: The README’s Phase 1 documentation incorrectly places sandbox
bootstrap in Phase 1; update README.md lines 140-140 and 309-315 to match the
Makefile, describing Phase 1 as reconnaissance only and Phase 2 as the phase
that gates or performs sandbox bootstrap. Ensure both documented subphase
sequences are consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| Six phases. Each one is a `make` target. Each one writes to disk. | ||
|
|
||
| 1. **Recon (`make phase-1`)** — runs as three subphases: (1a) target profiling and CodeQL plan generation, (1b) CodeQL-assisted reconnaissance using static analysis signals, and (1c) sandbox bootstrap. Writes notes under `itemdb/notes/` including a file-risk-index informed by CodeQL findings. | ||
| 1. **Recon (`make phase-1`)** — runs as three subphases: (1a) target profiling and CodeQL plan generation, (1b) sandbox bootstrap (Docker-based sandbox setup), and (1c) CodeQL-assisted reconnaissance using static analysis signals. Writes notes under `itemdb/notes/` including a file-risk-index informed by CodeQL findings. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Correct the documented Phase 1 sequencing.
The README claims sandbox bootstrap runs within make phase-1, but the supplied Makefile runs reconnaissance in Phase 1 and performs sandbox bootstrap gating in Phase 2.
README.md#L140-L140: remove or correct the claim thatmake phase-1includes sandbox bootstrap.README.md#L309-L315: align the subphase sequence with the actual targets, or update the implementation to match this documentation.
📍 Affects 1 file
README.md#L140-L140(this comment)README.md#L309-L315
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 140, The README’s Phase 1 documentation incorrectly places
sandbox bootstrap in Phase 1; update README.md lines 140-140 and 309-315 to
match the Makefile, describing Phase 1 as reconnaissance only and Phase 2 as the
phase that gates or performs sandbox bootstrap. Ensure both documented subphase
sequences are consistent.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes documentation gaps in
README.mdandMakefilehelp text that didn't reflect recent feature additions and had incorrect details.Changes
README.md
Phase 1 subphase ordering — The prompts and code use 1a=profiling, 1b=sandbox bootstrap, 1c=reconnaissance, but the README had them inconsistently swapped. Fixed the overview description, workflow section, and prompts list.
Phase 1 workflow section — Rewrote from outdated "Two things happen together" to three clearly named subphases with the correct ordering and a note about CodeQL running between 1b and 1c.
Deep sweep section — Added missing features from recent commits:
FILES=for comma-separated multi-pattern selectionEXCLUDE=for exclusion globsRESET=1/RESTART=1for clearing sweep statetmp/sweep-state.txtMakefile
make help— Addedmake sweep RESET=1line missing from the sweep section.Verification
make tests)Summary by CodeRabbit
New Features
Documentation