Skip to content

Enhance accessibility guide with examples and FAQs#5262

Merged
ethanpalm merged 13 commits intomainfrom
mintlify/update-quickstart-page-66087
Apr 27, 2026
Merged

Enhance accessibility guide with examples and FAQs#5262
ethanpalm merged 13 commits intomainfrom
mintlify/update-quickstart-page-66087

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 9, 2026

Enhanced the accessibility documentation with actionable improvements including a Quick Wins section with CardGroup, expanded introduction highlighting user benefits, concrete before/after examples for common mistakes, comprehensive FAQ section, cross-references to related guides, expanded testing section with detailed mint a11y output interpretation, and a new "Maintain accessibility over time" section.

Files changed

  • guides/accessibility.mdx - Added Quick Wins cards, FAQ accordion, before/after examples, cross-references, expanded testing guidance, and maintenance section

Note

Low Risk
Low risk documentation-only updates; main risk is minor rendering/layout issues from new MDX components like CodeGroup, Tip, and AccordionGroup.

Overview
Enhances guides/accessibility.mdx to be more actionable. Updates the intro and “Get started” section to emphasize iterative, high-impact accessibility improvements.

Adds concrete good vs poor examples for table structure and theme contrast (via CodeGroup), plus new cross-links using Tip callouts.

Expands the mint a11y section with sample output interpretation, common fix snippets, and an additional CI-oriented flag (--fail-on-error), and appends a new AccordionGroup FAQ covering WCAG levels, screen reader testing, alt text vs captions, emoji usage, and handling code examples.

Reviewed by Cursor Bugbot for commit 6261ac6. Bugbot is set up for automated code reviews on this repo. Configure here.

mintlify Bot added 9 commits April 9, 2026 23:09
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

Mintlify-Source: dashboard-editor
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

Mintlify-Source: dashboard-editor
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

Mintlify-Source: dashboard-editor
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

Mintlify-Source: dashboard-editor
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

Mintlify-Source: dashboard-editor
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

Mintlify-Source: dashboard-editor
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

Mintlify-Source: dashboard-editor
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

Mintlify-Source: dashboard-editor
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>

Mintlify-Source: dashboard-editor
@mintlify-development
Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
userauth 🟡 Building Apr 9, 2026, 11:11 PM

Comment thread guides/accessibility.mdx Outdated
Comment thread guides/accessibility.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Comment thread guides/accessibility.mdx Outdated
Comment thread guides/accessibility.mdx Outdated
Comment thread guides/accessibility.mdx Outdated
Comment thread guides/accessibility.mdx Outdated
Comment thread guides/accessibility.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@ethanpalm ethanpalm merged commit 3f76360 into main Apr 27, 2026
6 checks passed
@ethanpalm ethanpalm deleted the mintlify/update-quickstart-page-66087 branch April 27, 2026 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants