Skip to content

Accessibility Audit - Alternative texts#109

Merged
Marcellokah merged 7 commits intomasterfrom
feature/accessibility-alt-texts
Jun 19, 2025
Merged

Accessibility Audit - Alternative texts#109
Marcellokah merged 7 commits intomasterfrom
feature/accessibility-alt-texts

Conversation

@Marcellokah
Copy link
Contributor

@github-actions
Copy link
Contributor

github-actions bot commented Jun 19, 2025

🌟 EkLine Reviewer

Hello! 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.

Marcellokah and others added 4 commits June 19, 2025 10:17
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>
@Marcellokah Marcellokah requested a review from Copilot June 19, 2025 08:20
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Heading component 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 Heading component or standard markdown headings for consistency.
    <h2 style={{ fontSize: "1.5rem" }}>Login</h2>

Marcellokah and others added 2 commits June 19, 2025 10:24
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Collaborator

@diana-lakatos diana-lakatos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Marcellokah!

@Marcellokah Marcellokah merged commit 9eced5d into master Jun 19, 2025
1 check passed
@Marcellokah Marcellokah deleted the feature/accessibility-alt-texts branch June 19, 2025 08:27
@github-actions
Copy link
Contributor

🚀 Deployed preview to https://docskit-preview.staging.oregon.platform-os.com/

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.

3 participants