Skip to content

docs: release-closeout doc review for 0.8.2#223

Merged
pbean merged 2 commits into
mainfrom
docs/release-closeout-0.8.2
Jul 21, 2026
Merged

docs: release-closeout doc review for 0.8.2#223
pbean merged 2 commits into
mainfrom
docs/release-closeout-0.8.2

Conversation

@pbean

@pbean pbean commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

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 of docs/, the README, and the settings inventory (policy.py/POLICY_TEMPLATE/core.toml) to ensure nothing shipped undocumented.

The docs were broadly complete already — stories mode, the --json contract, 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

Gap Fix
Native-Windows/psmux status contradictory setup-guide + multiplexer-backends said "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.
CHANGELOG missing psmux entry Added an [Unreleased] "Added" entry for the native-Windows psmux backend.
scm.rollback_on_failure / scm.preserve_keep in no prose Documented in the README [scm] block + worktree-isolation prose.
README [limits] block lagging Added max_followup_reviews, dev_stall_nudges_cap, workflow_stall_nudges_cap, and the three session_budget_* knobs.
tui-guide settings table Added rows for git_timeout_s, teardown_grace_s, workflow_stall_nudges_cap.
README trailing the guides Added list --json, validate --spec, resolve --force, and the active-agent indicator to the dashboard prose.
opencode-http missing from CLI lists Added to the FEATURES + setup-guide supported-CLI lists (README already covered it).

Notes

  • Docs only — no code changes.
  • Values pulled from the authoritative POLICY_TEMPLATE (policy.py), not invented.
  • trunk check clean across all 6 files (prettier realigned two touched tables).
  • Version bump + broader CHANGELOG curation left to the /bmad-release step.

Summary by CodeRabbit

  • New Features

    • Added experimental native Windows support through the bundled psmux terminal multiplexer.
    • Added OpenCode HTTP/SSE adapter documentation and setup guidance.
    • Expanded command documentation for validation, resolution, and run listing, including JSON output.
    • Added documentation for session limits, recovery behavior, and new TUI settings.
  • Documentation

    • Updated platform prerequisites, multiplexer behavior, capability references, and TUI dashboard details.

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.
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@pbean, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 47 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2da7365d-2d10-420a-bd7f-32fcdca044b1

📥 Commits

Reviewing files that changed from the base of the PR and between 90debc9 and e366775.

📒 Files selected for processing (2)
  • docs/multiplexer-backends.md
  • docs/tui-guide.md

Walkthrough

The documentation now covers experimental native-Windows psmux, OpenCode HTTP/SSE adapter workflows, expanded CLI controls and JSON behavior, additional policy settings, worktree recovery semantics, and TUI settings.

Changes

Platform and workflow documentation

Layer / File(s) Summary
Native-Windows psmux documentation
CHANGELOG.md, docs/FEATURES.md, docs/multiplexer-backends.md, docs/setup-guide.md
Documents bundled experimental psmux, platform-default selection, PATH and version requirements, session naming, and Windows support status.
OpenCode adapter workflow
docs/FEATURES.md, docs/setup-guide.md
Documents the opencode/opencode-http HTTP/SSE profile, authentication, model configuration, hookless behavior, and headless execution.
Command, policy, and TUI reference updates
README.md, docs/tui-guide.md
Adds CLI flags and JSON semantics, documents new limits and SCM recovery settings, updates worktree isolation guidance, and lists additional TUI settings.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: dracic

Poem

I’m a rabbit with docs in my den,
Psmux hops through Windows again.
OpenCode streams softly at night,
New flags make the workflows bright.
Policy knobs line up in a row—
TUI settings now help them grow.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the PR’s documentation-focused 0.8.2 release closeout scope.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/release-closeout-0.8.2

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@pbean

pbean commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator Author

@CodeRabbit review

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between cd88b01 and 90debc9.

📒 Files selected for processing (6)
  • CHANGELOG.md
  • README.md
  • docs/FEATURES.md
  • docs/multiplexer-backends.md
  • docs/setup-guide.md
  • docs/tui-guide.md

Comment thread docs/multiplexer-backends.md Outdated
Comment thread README.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.
@pbean
pbean merged commit 03d7297 into main Jul 21, 2026
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant