PROJ-153 Overhaul Corgi README - #370
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Summary by CodeRabbit
WalkthroughREADME.md is rewritten with product-first onboarding, governance and ranking explanations, updated architecture and repository references, reorganized development and interface guidance, consolidated documentation links, and explicit research citation boundaries. ChangesREADME overhaul
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related issues
Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Warning Review ran into problems🔥 ProblemsThese MCP integrations need to be re-authenticated in the Integrations settings: Notion Comment |
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
coderabbitai
Bot
added
the
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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`:
- Around line 190-191: Update the README documentation around the docs:verify
verification gate to either resolve the existing npm run docs:verify failure or
explicitly document that it currently exits nonzero due to repository-wide
documentation freshness debt. Ensure readers understand this is a known
pre-existing limitation rather than an unexplained clean-checkout failure.
- Around line 148-183: Update the “Install and run” sequence in the README to
add an explicit readiness gate after “docker compose up -d” and before “npm run
migrate”/“npx tsx scripts/seed-governance.ts”; use the existing Compose service
names postgres and redis and document waiting until both report healthy. Add a
regression test that simulates delayed Postgres and Redis readiness and verifies
migrations do not run until both services are healthy.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 6889bb81-4bb4-40b6-8d60-1b4917213f73
📒 Files selected for processing (1)
README.md
|
@coderabbitai full review |
✅ Action performedFull review finished. |
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`:
- Around line 171-173: Update the Docker Compose prerequisites and startup
instructions around the “docker compose up --wait --wait-timeout” command to
explicitly require Compose v2.17.0 or newer. Add a documentation smoke test
covering the install flow with that minimum supported version, without replacing
the existing wait behavior.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: de4fa815-0ada-4f28-ae2c-f07ac18f690a
📒 Files selected for processing (1)
README.md
|
@coderabbitai full review |
✅ Action performedFull review finished. You're currently rate limited under our Fair Usage Limits Policy. Your recent PR review activity is in the 95th percentile or higher among CodeRabbit users, so adaptive limits apply. Your next review will be available in 4 minutes. |
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`:
- Around line 96-102: Update the scoring documentation around the formula to
call the aggregate result “total score” (or “combined score”) instead of
“component score.” Clarify that each component first produces a raw score, which
is multiplied by its approved signal weight, and that the weighted contributions
are summed into the total.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: c040c0b5-aac1-43df-9f3b-e35c05afc122
📒 Files selected for processing (1)
README.md
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
README.md (2)
104-104: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winDocument the required registry and weight-key registration contract.
validateRegistryrequires everyScoringComponent.keyto have a matching governance weight key and rejects mismatches at module load. Saying external authors can implementScoringComponentwithout stating this registration requirement can lead contributors to integrations that fail immediately.AI agent prompt:
Update README.md Line 104 to state that contributed scoring components must be registered and paired one-to-one with a votable governance weight key. Add a documentation smoke assertion covering this requirement.🤖 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 104, Update the README description of external ScoringComponent contributions to explicitly require registration and a one-to-one pairing between each component key and a votable governance weight key. Add a documentation smoke assertion that verifies this registration requirement is stated.
185-187: 📐 Maintainability & Code Quality | 🔵 TrivialAdd regression coverage for the documented startup flow.
docs:verifycan validate README text and links, but it will not prove that the Compose readiness gate precedes migrations and seeding. Add a smoke test asserting command order and an integration test with delayedpostgresandredisreadiness to verify migrations do not start until both services are healthy.AI agent prompt:
Add documentation smoke coverage for the README install sequence: 1. Assert the Compose v2.17+ readiness command appears before migration and seed commands. 2. Simulate delayed postgres and redis readiness and verify migrations start only after both services report healthy.🤖 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` around lines 185 - 187, Add regression coverage for the README install sequence: extend documentation smoke tests to assert the Compose v2.17+ readiness command precedes migration and seed commands, and add an integration test that delays postgres and redis readiness until both report healthy before allowing migrations to start.
🤖 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.
Outside diff comments:
In `@README.md`:
- Line 104: Update the README description of external ScoringComponent
contributions to explicitly require registration and a one-to-one pairing
between each component key and a votable governance weight key. Add a
documentation smoke assertion that verifies this registration requirement is
stated.
- Around line 185-187: Add regression coverage for the README install sequence:
extend documentation smoke tests to assert the Compose v2.17+ readiness command
precedes migration and seed commands, and add an integration test that delays
postgres and redis readiness until both report healthy before allowing
migrations to start.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: 2d322fc0-7402-445e-81c9-bca2e0da3146
📒 Files selected for processing (1)
README.md
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
84-107: 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick winDocument the registry pairing contract in the ranking section.
The weighted-sum explanation is already clear, but the README still omits that everyScoringComponentmust be registered insrc/scoring/registry.tsand matched one-to-one with asrc/config/votable-params.tsweight key. That contract is what keeps new components loadable and prevents governance weights from drifting out of sync with the scorer.AI agent prompt: update
README.mdlines 84-107 to add the registration/weight-key requirement and add a docs smoke test that fails if registry and votable-params drift.🤖 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` around lines 84 - 107, Update the README Ranking Model section to state that every ScoringComponent must be registered in src/scoring/registry.ts and paired one-to-one with a weight key in src/config/votable-params.ts. Add a documentation smoke test that detects and fails when registry entries and votable-params weight keys drift out of sync.Source: MCP tools
🤖 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.
Outside diff comments:
In `@README.md`:
- Around line 84-107: Update the README Ranking Model section to state that
every ScoringComponent must be registered in src/scoring/registry.ts and paired
one-to-one with a weight key in src/config/votable-params.ts. Add a
documentation smoke test that detects and fails when registry entries and
votable-params weight keys drift out of sync.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository YAML (base), Organization UI (inherited)
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: def6aebe-d167-4021-b03a-113189cf8198
📒 Files selected for processing (1)
README.md
|
@coderabbitai full review |
✅ Action performedFull review finished. You're currently rate limited under our Fair Usage Limits Policy. Your recent PR review activity is in the 95th percentile or higher among CodeRabbit users, so adaptive limits apply. Your next review will be available in 45 minutes. |
AndrewNordstrom
removed
the
documentation
|
README-only emergency exception receipt: exact head |
1 participant
What changed
web-nextsetup, API/CLI references, documentation links, and citation guidance.Why
The previous README no longer matched the shipped product surface or available public proof. It mixed the canonical and legacy frontends, omitted the current walkthrough and demo paths, and blurred production behavior with the isolated reviewer demo.
Validation
npm run verify— pass: 155 test files / 1,703 tests, root TypeScript build, CLI/SDK builds, legacy web lint/build, and canonical Next.js static export.git diff --check— pass.npm run docs:verify— README links, commands, and repository references are clean; the command still exits nonzero on pre-existing repository-wide freshness debt (12 tracked documents at 127 days versus the 120-day limit).Reviewer focus
Closes PROJ-153