fix(a11y): harden Mermaid validator and fix 20 pre-type accTitle/accDescr violations#1017
Conversation
…escr violations Added a guard in validate-mermaid-accessibility.js that rejects Mermaid blocks where accTitle or accDescr appears before the diagram type declaration. GitHub's renderer requires the diagram type (e.g. `flowchart TD`) to be the first meaningful line; accessibility attributes placed above it are invisible to screen readers and incorrectly indicate a compliant block. Corrected all 20 affected diagrams across 9 files by moving each diagram type declaration to the first position. All 60 diagrams now pass at 100% compliance. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AuT8NQeGYY9UQHLsX3MMHc
|
Warning Review limit reached
More reviews will be available in 46 minutes and 28 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?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 credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. 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, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (11)
✨ 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 |
|
✅ Template check passed after update. Thanks for fixing the PR description. |
🎨 Mermaid Diagram Validation✅ All Mermaid diagram checks passed.
|
🔍 Reviewer Summary for PR #1017CI Status: ✅ Recommendations
|
Metadata governance
|
There was a problem hiding this comment.
Code Review
This pull request hardens the Mermaid diagram accessibility validator in scripts/validation/validate-mermaid-accessibility.js to reject diagrams where accTitle or accDescr are placed before the diagram type declaration. It also updates 20 affected diagrams across 9 documentation files to ensure compliance, and documents these changes in the CHANGELOG. I have no feedback to provide as there are no review comments.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Footer validation (validate:footers) requires all changed markdown files to carry the LightSpeed branded footer. Auto-fixed with --fix flag. Also resolved setext heading style conflict in quality-assurance.instructions.md. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01AuT8NQeGYY9UQHLsX3MMHc
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Linked issues
Closes #669
Context
accTitle/accDescrbefore the diagram type lineRoot Cause
accTitleoraccDescrappeared before the diagram type declaration (e.g.flowchart TD) would pass the accessibility validator despite being incorrectly structured. GitHub's renderer requires the diagram type to be the first meaningful line; attributes placed above it are parsed incorrectly and invisible to screen readers.Fix Summary
scripts/validation/validate-mermaid-accessibility.jsthat detects whenaccTitle/accDescris the first meaningful line and returns an error immediately (same early-return pattern as the existing YAML front-matter guard).Verification
node scripts/validation/validate-mermaid-accessibility.js— 60/60 diagrams accessible, 0 non-compliantversionandlast_updatedbumped on all modified markdown filesRisk & Rollback
fa8b722Changelog
Fixed
accTitle/accDescrplaced before diagram type — Added a guard inscripts/validation/validate-mermaid-accessibility.jsthat rejects any Mermaid block whereaccTitleoraccDescrappears before the diagram type declaration. Corrected all 20 affected diagrams across 9 files. 60/60 diagrams are now compliant.Checklist (Global DoD / PR)
🤖 Generated with Claude Code
https://claude.ai/code/session_01AuT8NQeGYY9UQHLsX3MMHc