docs: restore the guard's own section, and tighten two pages - #14
Conversation
|
Warning Review limit reached
Next review available in: 24 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: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 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 |
saving.md had a structural bug I introduced when I added the 204 section: the "The guard rejects:" list and everything after it describes ValidateMergePatch, but my two new sections were inserted between the guard and its own description. It read as though the bullets described gateway.Project. The guard's rules are back next to the guard, under a heading of their own, and the 204 and adoptSaved sections follow. Also trimmed: the em-dashes, "this is the recommended shape and it is the one to reach for unless you have a specific reason not to" (which says nothing the heading does not), and four paragraphs in why-a-gateway.md that took a run-up to every point. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
b312875 to
7c2d2b1
Compare
A docs pass, and it turned up a real structural bug rather than just prose.
The bug: I split the guard from its own description
docs/saving.md opens with
ValidateMergePatchand its example. The list beginning "The guard rejects:" (redacted paths,managedFields,statusunderkrm-spec/v1, malformed patches) describes that guard.When I added the 204 and
adoptSavedsections in #10, I inserted them between the guard and its own description. So the page read:A reader arriving at those bullets would reasonably conclude that
gateway.Projectrejects redacted paths and malformed merge patches. It does neither. The rules are now back with the guard, under What the guard rejects, and the 204 andadoptSavedsections follow it.The prose
saving.md(the last two indocs/).SharedBackendsecurity trade and theSSARAuthorizerescape hatch both stay, because that is the part a reader can get wrong.Docs only.
🤖 Generated with Claude Code