docs(review): fix docs pages that describe checkRunMode/reviewCheckMode backwards#5301
Conversation
…de backwards Two shipped docs pages misattributed which field controls which check-run: docs.how-reviews-work.tsx claimed checkRunMode publishes "Gittensory Orb Review Agent" (it publishes "Gittensory Context" instead), and docs.github-app.tsx claimed both checks are controlled by checkRunMode, self-contradicting its own correct statement two sections later that reviewCheckMode is the gate's authority. Also scopes repo-profile.ts's "legacy" comment to gateCheckMode only (checkRunMode is live, not legacy), adds a JSDoc to checkRunMode cross-referencing reviewCheckMode, and removes the stale "deep" checkRunDetailLevel option from three docs pages (the type was narrowed to minimal|standard in #4620). Refs #5283
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
gittensory-ui | 10417c9 | Commit Preview URL Branch Preview URL |
Jul 12 2026, 01:33 PM |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5301 +/- ##
=======================================
Coverage 94.37% 94.37%
=======================================
Files 474 474
Lines 40128 40128
Branches 14631 14631
=======================================
Hits 37869 37869
Misses 1583 1583
Partials 676 676
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ Gittensory review result - approve/merge recommendedReview updated: 2026-07-12 13:36:32 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 7 non-blocking
Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.
Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands Visual preview
Click any thumbnail to open the full-size screenshot. Before = production · After = this PR's preview deploy. 🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed 💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →. Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.
|
CI's ui:lint caught formatting the earlier commit's editor didn't apply. No content change, whitespace/wrapping only.
Summary
docs.how-reviews-work.tsx:298-301claimedcheckRunModepublishes the "Gittensory Orb Review Agent" check — backwards; it publishes "Gittensory Context".docs.github-app.tsx:149-152claimed both checks are controlled bycheckRunMode— false for the Gate check, and self-contradicts the same file's own correct statement 15 lines later thatreviewCheckModeis the gate's authority.src/review/repo-profile.ts'sgatePublishesCheckdoc lumped livecheckRunModein with genuinely-deprecatedgateCheckModeas "legacy" — scoped that claim correctly.checkRunMode(previously had none) cross-referencingreviewCheckMode.deepcheckRunDetailLeveloption from 3 docs pages — the type was narrowed tominimal | standardin Resolve dead config branches (wire or remove) #4620, "deep" was never removed from prose.Scope
Docs/comment-only:
docs.how-reviews-work.tsx,docs.github-app.tsx,docs.tuning.tsx,src/review/repo-profile.ts,src/types.ts.Validation
npm run typecheck— cleannpm run ui:typecheck— cleannpx vitest run test/unit/docs-github-app.test.ts test/unit/check-docs-drift-script.test.ts— 35/35 passing (the existing assertions on unchanged nearby text still hold)npm run docs:drift-check— cleanSafety
No behavior change, docs/comments only.
Closes #5283