docs: close the pre-release gaps — changelog coverage, watches config, section order#2108
Conversation
…, section order Release prep for the 25 commits sitting on main since v0.105.2. CHANGELOG [Unreleased] was missing four user-facing changes and had **two separate `### Fixed` sections**, which would have rolled into a malformed release section. Merged them, reordered to Keep a Changelog's Added/Changed/Fixed, and added entries for: - the watch-tool gating (#2099) — a DEFAULT-OFF behavior change, so it gets an explicit "existing configs must set `watches.enabled: true`" note - the PR-review head-SHA fix (#2100) - the Tools-panel Filesystem group chips (#2084) - the PWA theme-color fix (#2083) ADRs and CI-internal commits are deliberately not listed — this repo cites ADRs inline in the entry they belong to rather than as standalone lines. `watches.enabled` shipped with NO documentation outside a commented block in the example config, while simultaneously flipping the tools to default-off. Added `## watches` to the configuration reference and a "Turn it on first" section to the watches guide, both stating the three things the flag deliberately does not do — it never deletes stored watches, the background poller keeps running, and `goal.enabled` must ALSO be true because the tools ride inside the goal tool group. Wording checked against the schema comment in `graph/config.py` and the example config so the three don't drift. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
QA panel review — PASS
code-review · head 7da77d6a57b7 · formal
[review-synthesizer completed: workflow code-review:report]
The change carries negligible risk as no defects were identified by the review panel or the verification pass. There are no items to fix, and there was no disagreement among the finders. Verification confirmed the absence of findings.
[]|
Warning Review limit reached
Next review available in: 53 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: ASSERTIVE Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
✨ 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 |
#2107 shipped a user-facing fix with no changelog entry — the same gap #2108 just closed for four other commits. Added under Fixed so it's carried into v0.106.0 rather than being invisible in the release notes. Co-authored-by: GitHub CI <ci@example.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Release prep for the 25 commits on
mainsince v0.105.2.Changelog
[Unreleased]had two separate### Fixedsections, which would have rolled into a malformed release section. Merged them and reordered to Keep a Changelog's Added / Changed / Fixed.Four user-facing changes were missing entirely:
watches.enabled, default off (#2099)The watch entry calls out explicitly that existing configs relying on those tools must now set
watches.enabled: true— it's a silent capability removal otherwise.ADRs and CI-internal commits are deliberately not listed: this repo cites ADRs inline in the entry they belong to (see the 0.105.0 section) rather than as standalone lines.
Docs
watches.enabledshipped with no documentation outside a commented block in the example config — while simultaneously flipping the tools to default-off. That's the combination most likely to read as "the watch tools disappeared."docs/reference/configuration.mdgains a## watchessection (there wasn't one at all).docs/guides/watches.mdgains a "Turn it on first" section, since the guide otherwise opens by teaching a feature you can no longer use.Both state the three things the flag deliberately does not do, because they're what bites when toggling it on a running agent:
on_met.goal.enabledmust also be true; the tools ride inside the goal tool group, sowatches.enabled: truealone binds nothing.Wording verified against
graph/config.py:460-467and the example config so the three don't drift apart.Not included
The four open PRs (#1995, #1999, #2001, #2007) are all drafts that explicitly ask for your review — "needs your eyes before merge", "for local testing before merge (as requested)", "decision record in progress". Two also have conflicts. They're parked deliberately, so I left them out of the release rather than sweeping them in.
Testing
ruffclean · 3899 Python tests · docs nav regenerated + its sync test passing ·changelog.py checkpasses.🤖 Generated with Claude Code