Accessibility Audit - Alternative texts#109
Merged
Marcellokah merged 7 commits intomasterfrom Jun 19, 2025
Merged
Conversation
Contributor
🌟 EkLine ReviewerHello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page. For questions or feedback, please email support@ekline.io. |
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances accessibility by adding descriptive alternative texts and updating heading semantics across documentation components.
- Added alt/aria-label attributes to video elements and expanded image alt texts for better screen reader support
- Replaced markdown headings with styled HTML heading tags in MDX files for consistent typography
- Adjusted JavaScript logic to safely initialize the intersection observer’s heading map
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/src/components/home.js | Added alt on <video> (should be aria-label) and expanded image alt texts |
| src/src/@platformos/gatsby-theme-platformos-docskit/components/toc.js | Initialized reduce accumulator with an empty object fallback |
| src/docs/06-docs-as-code-course.mdx | Replaced ### markdown headings with <h2 style> tags |
| src/docs/05-pricing.mdx | Updated pricing display to use <strong> and expanded “POA” text |
| src/docs/03-case-studies/product-site.mdx | Styled feature cards with <h3 style> and added aria-label on <video> |
| src/docs/03-case-studies/docskit-mdx-partials.mdx | Styled feature cards with <h3 style> tags |
| src/docs/03-case-studies.mdx | Styled case-study cards with <h2 style> tags |
Comments suppressed due to low confidence (2)
src/docs/06-docs-as-code-course.mdx:28
- [nitpick] Inline styling on heading tags can lead to inconsistent typography. Consider using the shared
Headingcomponent or standard markdown headings for consistency.
<h2 style={{ fontSize: "1.5rem" }}>Signup</h2>
src/docs/06-docs-as-code-course.mdx:34
- [nitpick] Inline styling on heading tags can lead to inconsistent typography. Consider using the shared
Headingcomponent or standard markdown headings for consistency.
<h2 style={{ fontSize: "1.5rem" }}>Login</h2>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
diana-lakatos
approved these changes
Jun 19, 2025
Collaborator
diana-lakatos
left a comment
There was a problem hiding this comment.
Thank you @Marcellokah!
Contributor
|
🚀 Deployed preview to https://docskit-preview.staging.oregon.platform-os.com/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
https://www.figma.com/board/IOK5aDYQxav7VCDTgJoovI/Accessibility-Audit-and-Roadmap-DocsKit?node-id=2-7987&t=D0JbKTLhBsf5dinQ-4