Add docs audit severities, CI report upload, and dead Pro-link cleanup#61
Add docs audit severities, CI report upload, and dead Pro-link cleanup#61
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✨ 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 |
|
Cloudflare preview deployed.
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix prepared a fix for the issue found in the latest run.
- ✅ Fixed: Missing blank line between report header and body
- Added an explicit newline between the joined header and body so the Markdown section heading is separated from the first page entry by a blank line.
Or push these changes by commenting:
@cursor push 26ab85dc5e
Preview (26ab85dc5e)
diff --git a/scripts/audit-docs.mjs b/scripts/audit-docs.mjs
--- a/scripts/audit-docs.mjs
+++ b/scripts/audit-docs.mjs
@@ -309,7 +309,7 @@
})
.join("\n");
- return `${header.join("\n")}${body}`;
+ return `${header.join("\n")}\n${body}`;
}
function shouldFailAudit(pages) {| .join("\n"); | ||
|
|
||
| return `${summary.join("\n")}\n${body}`; | ||
| return `${header.join("\n")}${body}`; |
There was a problem hiding this comment.
Missing blank line between report header and body
Low Severity
The old buildReport used `${summary.join("\n")}\n${body}` which placed a blank line between the "## Page-by-page comments" heading and the first page entry. The new code uses `${header.join("\n")}${body}`, dropping the extra \n. Since the header array ends with "", join("\n") produces a trailing single newline, so the section heading runs directly into the first ### page entry with no separating blank line. This is a formatting regression in the generated Markdown report.
1 participant
Closes #12
Closes #13
Closes #59
Summary
scripts/audit-docs.mjsto support severity levels (error,warn,info)pro.reactonrails.comreferences with the canonical Pro docs destination in both prepared docs output and the site Pro pageVerification
npm run prepare && npm run audit:docs -- --output VALIDATION_REPORT_CI.md --fail-on error && npm run buildErrors: 0on the prepared docs setNote
Medium Risk
Medium risk because it changes CI gating behavior and rewrites docs validation logic, which could introduce unexpected build failures or miss/over-report findings. No production runtime or security-sensitive code is modified.
Overview
Adds a severity-based docs audit (
error/warn/info) that ignores fenced code blocks, narrows version-floor checks to React-on-Rails-context mentions, and produces richer report/summary counts with optional failure via--fail-on.Updates the site build workflow to run this audit, upload the generated report as an artifact, append key metrics to the GitHub Actions step summary, and fail the job only when blocking (
error-level) findings are present.Cleans up dead
pro.reactonrails.comlinks by rewriting them to the canonical Pro docs URL during docs preparation and by updating the Docusaurus Pro page CTA to point at/docs/pro.Written by Cursor Bugbot for commit 7cfa4f7. This will update automatically on new commits. Configure here.