docs: refine VPAT with minor adjustments#7906
Conversation
|
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
There was a problem hiding this comment.
Pull request overview
Refines the generated VPAT/OpenACR documentation output in @coveo/atomic-a11y, primarily by making evaluation methods more explicit and improving the VPAT header metadata/rendering.
Changes:
- Rewords the accessibility evaluation methods strings used in generated reports.
- Adds a Handlebars
dateFormathelper and uses it to render a Month/Year VPAT header. - Updates OpenACR report notes and expands the VPAT template header with additional metadata (standard, report currency, etc.).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| packages/atomic-a11y/src/reporter/report-builder.ts | Updates evaluationMethods phrasing used as the source for downstream OpenACR/VPAT outputs. |
| packages/atomic-a11y/src/openacr/vpat-renderer.ts | Registers a new dateFormat Handlebars helper to format report dates for the VPAT template. |
| packages/atomic-a11y/src/openacr/report-builder.ts | Adjusts the OpenACR report notes text that appears in the generated VPAT. |
| packages/atomic-a11y/scripts/vpat-from-openacr.handlebars | Updates VPAT header content (VPAT version/date, applicable standard, report version, and currency statement). |
| 'Interactive: Storybook interactive tests for keyboard navigation and focus management', | ||
| ] | ||
| : []), | ||
| 'Manual: keyboard-only testing; screen reader testing; visual inspection at 200% and 400% zoom; reflow verification at 320 CSS px viewport width; non-text contrast verification.', |
| notes: | ||
| 'Generated from a11y/reports/a11y-report.json. Conformance is derived from axe-core results, interactive keyboard tests, and manual audits. Rows marked [Manual audit required] have no automated or interactive coverage and are reported as Does Not Support pending manual verification.', | ||
| 'Generated from a11y/reports/a11y-report.json. Conformance is derived from axe-core results, interactive keyboard tests, and manual audits.', |
| **Report Date:** {{report_date}} | ||
|
|
||
| **Version:** {{version}} |
|
Important Testing in progress…🟢 UI Tests: 458 tests unchanged |
|
Tip All tests passed and all changes approved!🟢 UI Tests: 458 tests unchanged |
@coveo/atomic
@coveo/atomic-hosted-page
@coveo/atomic-legacy
@coveo/atomic-react
@coveo/auth
@coveo/bueno
@coveo/create-atomic
@coveo/create-atomic-component
@coveo/create-atomic-component-project
@coveo/create-atomic-result-component
@coveo/create-atomic-rollup-plugin
@coveo/headless
@coveo/headless-react
@coveo/shopify
commit: |
No description provided.