docs: release-closeout doc review for 0.8.2#223
Conversation
Cross-referenced every user-facing change since v0.8.1 (234 commits) against the docs and closed the remaining gaps. Docs were broadly complete already; these are surgical fixes. - Reconcile the native-Windows/psmux status: setup-guide + multiplexer-backends said "native Windows not yet shipped" while ROADMAP/porting treat psmux as shipped in-tree. Framed as experimental via the bundled psmux backend (prereqs: psmux + pwsh, psmux > 3.3.6), not promoted to the supported tier. - CHANGELOG: add the native-Windows psmux multiplexer backend Added entry. - README: document scm.rollback_on_failure + scm.preserve_keep (previously in no prose); fill the [limits] block (max_followup_reviews, dev_stall_nudges_cap, workflow_stall_nudges_cap, session_budget_*); add list --json, validate --spec, resolve --force, and the active-agent indicator to the dashboard prose. - tui-guide: add settings-table rows for git_timeout_s, teardown_grace_s, workflow_stall_nudges_cap. - FEATURES + setup-guide: add opencode-http to the supported-CLI lists.
|
Warning Review limit reached
Next review available in: 47 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughThe documentation now covers experimental native-Windows ChangesPlatform and workflow documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Suggested reviewers: Poem
🚥 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 |
|
@CodeRabbit review |
✅ Action performedReview finished.
|
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 `@docs/multiplexer-backends.md`:
- Line 20: Update the platform-default entry in the multiplexer backend
precedence documentation to state that it is selected only when registered and
available, including psmux availability requirements for pwsh and versions above
3.3.6. Add the final platform-match/history fallback so the documented order
matches the registry logic in the multiplexer selection implementation.
In `@README.md`:
- Around line 398-399: Add settings-table rows for rollback_on_failure and
preserve_keep in the TUI settings reference in docs/tui-guide.md, matching the
existing table structure and descriptions from the policy template. Ensure both
keys appear in the complete editor reference with their supported values and
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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: a93bc15f-2ed4-42c6-ba74-0c8d820bdb6f
📒 Files selected for processing (6)
CHANGELOG.mdREADME.mddocs/FEATURES.mddocs/multiplexer-backends.mddocs/setup-guide.mddocs/tui-guide.md
- multiplexer-backends: precedence list now says the platform default is chosen only when registered AND available, and adds the historical platform-match fallback (step 5), matching multiplexer._select(). - tui-guide: add scm.rollback_on_failure and scm.preserve_keep rows to the editor settings reference; both are editable TUI fields (core.toml) that were missing from the 'complete editor reference' table.
Context
Pre-release documentation review of every user-facing change since v0.8.1 (234 commits). Cross-referenced the full
[Unreleased]CHANGELOG, the CLI argparse surface, all ofdocs/, theREADME, and the settings inventory (policy.py/POLICY_TEMPLATE/core.toml) to ensure nothing shipped undocumented.The docs were broadly complete already — stories mode, the
--jsoncontract, graceful stop, the agent indicator, opencode-http, antigravity, the budget guard, resizable panes, and the multiplexer mechanism all had dedicated coverage. These are the surgical gaps that remained.Changes
setup-guide+multiplexer-backendssaid "native Windows not yet shipped" while ROADMAP/porting treat psmux as shipped in-tree. Reconciled to experimental via the bundled psmux backend (prereqs:psmux+pwsh, psmux > 3.3.6), not promoted to the Linux/macOS/WSL supported tier.[Unreleased]"Added" entry for the native-Windows psmux backend.scm.rollback_on_failure/scm.preserve_keepin no prose[scm]block + worktree-isolation prose.[limits]block laggingmax_followup_reviews,dev_stall_nudges_cap,workflow_stall_nudges_cap, and the threesession_budget_*knobs.git_timeout_s,teardown_grace_s,workflow_stall_nudges_cap.list --json,validate --spec,resolve --force, and the active-agent indicator to the dashboard prose.Notes
POLICY_TEMPLATE(policy.py), not invented.trunk checkclean across all 6 files (prettier realigned two touched tables)./bmad-releasestep.Summary by CodeRabbit
New Features
psmuxterminal multiplexer.Documentation