Repository navigation
Add accessibility directive with screen-reader/ARIA detail companion - #95
Conversation
…der/ARIA detail companion Introduces directives/accessibility.md as the accessibility floor for user-facing UI work, wired into adaptive routing, and adds a lazy-loaded directives/references/accessibility-detail.md companion covering JAWS/NVDA/VoiceOver test procedures and complex ARIA widget patterns for custom widgets and formal audits. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 54 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 (1)
📝 WalkthroughWalkthroughAdds a routed accessibility directive for user-facing UI work, an optional companion for screen-reader and complex ARIA guidance, adaptive-routing and manifest registration, repository/template documentation, a changeset, and an evaluation scenario. ChangesAccessibility directive and routing
Estimated code review effort: 2 (Simple) | ~15 minutes Sequence Diagram(s)sequenceDiagram
participant UIChange
participant AdaptiveRouting
participant AccessibilityDirective
participant AccessibilityCompanion
UIChange->>AdaptiveRouting: detect user-facing UI or interaction work
AdaptiveRouting->>AccessibilityDirective: load accessibility.md
AccessibilityDirective->>AccessibilityCompanion: load for complex widgets, screen-reader tests, or audits
AccessibilityCompanion-->>UIChange: provide detailed verification guidance
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
manifest.json is generated from each directive's frontmatter assets field, not hand-edited directly, so the manually added assets entry was stripped by the manifest:check CI step. Move the accessibility-detail.md reference into directives/accessibility.md's frontmatter, matching the adaptive-routing pattern. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 58cbb5c97d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - implementation | ||
| - review | ||
| - testing | ||
| --- |
There was a problem hiding this comment.
Add assets: [references/accessibility-detail.md] before this delimiter. scripts/generate-manifest.ts derives each entry's assets exclusively from frontmatter, so npm run manifest:check will remove the manually committed accessibility asset from manifest.json and fail; if that generated manifest is retained, CLI installations will also omit the advertised companion.
AGENTS.md reference: AGENTS.md:L136-L136
Useful? React with 👍 / 👎.
| or docs-only prose unless those changes alter user-facing UI instructions or | ||
| accessibility requirements. | ||
|
|
||
| Load the companion `directives/references/accessibility-detail.md` only when |
There was a problem hiding this comment.
Document the installed path .agents/directives/references/accessibility-detail.md as well as the source-tree path. For projects using the CLI, installEntry places companion assets beneath .agents/, so the path given here does not exist and agents cannot load the detailed guidance for custom widgets or requested audits; the same source-only reference near the verification section should be corrected too.
AGENTS.md reference: AGENTS.md:L136-L136
Useful? React with 👍 / 👎.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@evals/scenarios/accessibility-directive-routing.md`:
- Around line 23-31: Extend the accessibility directive routing scenario’s
Expected Behaviors to cover lazy loading of
directives/references/accessibility-detail.md: require it to remain unloaded for
the simple toggle, and require it to load for a custom widget or explicit
screen-reader audit. Preserve the existing parent-directive routing
expectations.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 0bd16794-5b2e-4e57-88ef-c20a62fbecf8
📒 Files selected for processing (12)
.changeset/thick-hounds-attend.mdAGENTS.mdREADME.mddirectives/accessibility.mddirectives/adaptive-routing.mddirectives/references/accessibility-detail.mddirectives/references/adaptive-routing-detail.mdevals/scenarios/accessibility-directive-routing.mdmanifest.jsontemplates/AGENTS.mdtemplates/CLAUDE.mdtemplates/copilot-instructions.md
| ## Expected Behaviors | ||
|
|
||
| - [ ] Selects Full Path because adding a visibility toggle and updating an interaction test changes user-facing behavior. | ||
| - [ ] Loads or explicitly names `directives/accessibility.md` because the touched surface is a form UI component with an interactive control, focus/keyboard behavior, and frontend tests. | ||
| - [ ] Loads or explicitly names `skills/test-reviewer/SKILL.md` because the prompt includes frontend interaction test updates. | ||
| - [ ] Names relevant accessibility evidence such as accessible name for the toggle, native button semantics, keyboard activation, visible focus, form label/error preservation, and role/name-based test queries. | ||
| - [ ] Keeps accessibility as a directive or surface requirement, not a standalone specialist skill unless the prompt asks for an accessibility audit. | ||
| - [ ] States that `directives/accessibility.md` should not load for the backend-only JSON serialization edit unless it changes user-facing UI accessibility requirements. | ||
| - [ ] Lists final evidence with project-native test/lint/type checks or clear fallback wording if commands are unavailable. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Cover the lazy companion’s routing behavior.
This scenario verifies the parent directive but never asserts whether directives/references/accessibility-detail.md stays unloaded for the simple toggle or loads for a custom widget/explicit screen-reader audit. Add those positive and negative expectations so lazy loading regressions cannot pass unnoticed.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@evals/scenarios/accessibility-directive-routing.md` around lines 23 - 31,
Extend the accessibility directive routing scenario’s Expected Behaviors to
cover lazy loading of directives/references/accessibility-detail.md: require it
to remain unloaded for the simple toggle, and require it to load for a custom
widget or explicit screen-reader audit. Preserve the existing parent-directive
routing expectations.
1 participant
Summary
directives/accessibility.mdas the accessibility floor for user-facing UI implementation, testing, and review; wired into adaptive routing so it loads only for UI-touching surfaces.directives/references/accessibility-detail.mdcompanion (JAWS/NVDA/VoiceOver screen-reader test procedures, complex ARIA widget patterns, WCAG-mapped audit guidance) that loads only for custom composite widgets or explicit screen-reader/audit work.manifest.json, updatesREADME.md,AGENTS.md, and templates, and adds an eval scenario for routing coverage.Test plan
manifest.jsonis valid JSON and both entries resolve correctlydirectives/accessibility.mdand its companion load per the documented triggers (UI surfaces vs. custom widget/audit scope)evals/scenarios/accessibility-directive-routing.mdfor routing coverageSummary by CodeRabbit
New Features
Documentation
Tests