docs: replace metrics field table with a navigable index - #46
Conversation
Replaces the JSON field reference table with an index listing each of the 11 metrics and linking to its section. Restores the per-metric not-applicable conditions into the pages as a fourth fixed field, so every metric now states Definition, Computation, Not applicable, and Usability. Reorders the activity grid page so its usability statement sits with the metric rather than under a sub-heading, and marks the progress indicator threshold as process feedback rather than a metric.
|
Warning Review limit reached
Next review available in: 48 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 Plus Run ID: 📒 Files selected for processing (6)
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 |
1 participant
Summary
The previous PR added a JSON field reference table. That was a misread of the request:
what was wanted was a navigable index, not a serialization reference.
Index (
metrics/README.md): one row per metric, name hyperlinked to its section,with a short statement of what it measures. All 11 metrics, deep-linked.
Not-applicable conditions restored into the pages. They previously lived only in
the removed table. Each metric now states four fixed fields: Definition, Computation,
Not applicable, Usability — 11 of each across the section.
Activity grid page reordered. Its usability statement had drifted under the
Granularity sub-heading; it now sits with the metric. Sub-sections no longer borrow the
per-metric labels, and the progress indicator threshold is explicitly marked as process
feedback rather than a metric.
Test plan
mdbook buildclean