Skip to content

fix: add accessible captions to all markdown tables#193

Merged
1 commit merged into
mainfrom
fix/accessible-table-captions
May 10, 2026
Merged

fix: add accessible captions to all markdown tables#193
1 commit merged into
mainfrom
fix/accessible-table-captions

Conversation

@accesswatch
Copy link
Copy Markdown
Collaborator

  • Added captions or descriptions above every markdown table in documentation and guides for accessibility compliance
  • Follows WCAG and markdown accessibility best practices

This PR ensures all tables are accessible and compliant across the documentation set.

- Added captions or descriptions above every markdown table in documentation and guides for accessibility compliance
- Follows WCAG and markdown accessibility best practices
Copilot AI review requested due to automatic review settings May 9, 2026 17:46
@accesswatch accesswatch requested a review from taylorarndt as a code owner May 9, 2026 17:46
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 9, 2026

Peer Review Assigned

Hi @accesswatch! Your PR has been automatically paired with @taylorarndt for peer review.

For @taylorarndt:

This is a great opportunity to practice code review skills! Here's what to look for:

Content Quality:

  • Does the change accomplish what the issue describes?
  • Is the writing clear and helpful?
  • Are there any typos or grammar issues?

Accessibility:

  • Proper heading hierarchy (H1 → H2 → H3, no skips)?
  • Descriptive link text (not "click here")?
  • Alt text on images?
  • [TODO] markers removed?

Documentation:

  • Code blocks are properly formatted?
  • Tables have headers?
  • References/links work correctly?

Review Guidelines:

  • Be kind and constructive
  • Suggest improvements, don't just point out problems
  • Ask questions if something is unclear
  • Approve when ready or request changes with explanation

Resources:


Pairing by Learning Room Grouping Engine

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 9, 2026

Learning Room Validation Report

Great work. Your changes look good.

Resources

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 9, 2026

Hi! I am Aria. Here is my review of your pull request:

Report Status

Validation Needs Attention [ACTION REQUIRED]

Required Checks

  • Issue Reference
    PR should reference the issue it addresses (e.g., "Closes #12")
    Add "Closes #XX" to your PR description to automatically close the issue when merged. Learn more: docs/04-working-with-issues.md

  • PR Description

  • File Location
    Changes should be in learning-room/ directory only
    Student contributions should modify files in learning-room/docs/ only. Other directories are workshop infrastructure.

Suggestions for Improvement

These are optional but will make your contribution even better:

  • Good use of code blocks for examples
    Code blocks help both sighted and non-sighted users understand technical content.
  • Tables include proper headers
    Screen readers announce table headers, helping users navigate data.
  • Good use of code blocks for examples
    Code blocks help both sighted and non-sighted users understand technical content.
  • Tables include proper headers
    Screen readers announce table headers, helping users navigate data.
  • Tables include proper headers
    Screen readers announce table headers, helping users navigate data.
  • Good use of code blocks for examples
    Code blocks help both sighted and non-sighted users understand technical content.
  • Tables include proper headers
    Screen readers announce table headers, helping users navigate data.
  • Good use of code blocks for examples
    Code blocks help both sighted and non-sighted users understand technical content.
  • Tables include proper headers
    Screen readers announce table headers, helping users navigate data.
  • Tables include proper headers
    Screen readers announce table headers, helping users navigate data.

Accessibility Analysis

  • Heading Hierarchy Skip
    Heading jumps from H1 to H3. This breaks screen reader navigation.
    learning-room/.github/DEPLOYMENT_VALIDATION.md (line 277)
    Fix: Change "H3" to "H2" or add intermediate heading levels.

  • Non-Descriptive Link Text
    Found 1 instance(s) of "read more" link text. Screen reader users can't tell where the link goes.
    learning-room/.github/FACILITATOR_GUIDE.md
    Fix: Replace with descriptive text like "View keyboard shortcuts guide" or "Download the setup instructions".

  • Broken Link
    Link points to non-existent file: link
    learning-room/.github/FACILITATOR_GUIDE.md
    Fix: Verify the file path is correct or check if the file exists.

  • Broken Link
    Link points to non-existent file: link
    learning-room/.github/FACILITATOR_GUIDE.md
    Fix: Verify the file path is correct or check if the file exists.

  • Broken Link
    Link points to non-existent file: ../../facilitator/FACILITATOR_GUIDE.md
    learning-room/.github/IMPLEMENTATION_GUIDE.md
    Fix: Verify the file path is correct or check if the file exists.

  • Heading Hierarchy Skip
    Heading jumps from H1 to H3. This breaks screen reader navigation.
    learning-room/.github/SETUP_AND_MAINTENANCE.md (line 145)
    Fix: Change "H3" to "H2" or add intermediate heading levels.

  • Heading Hierarchy Skip
    Heading jumps from H1 to H3. This breaks screen reader navigation.
    learning-room/.github/SETUP_AND_MAINTENANCE.md (line 170)
    Fix: Change "H3" to "H2" or add intermediate heading levels.

  • Heading Hierarchy Skip
    Heading jumps from H1 to H3. This breaks screen reader navigation.
    learning-room/.github/SETUP_AND_MAINTENANCE.md (line 188)
    Fix: Change "H3" to "H2" or add intermediate heading levels.

  • Heading Hierarchy Skip
    Heading jumps from H1 to H3. This breaks screen reader navigation.
    learning-room/.github/SETUP_AND_MAINTENANCE.md (line 334)
    Fix: Change "H3" to "H2" or add intermediate heading levels.

  • Non-Descriptive Link Text
    Found 1 instance(s) of "click here" link text. Screen reader users can't tell where the link goes.
    learning-room/.github/STUDENT_GUIDE.md
    Fix: Replace with descriptive text like "View keyboard shortcuts guide" or "Download the setup instructions".

  • Non-Descriptive Link Text
    Found 2 instance(s) of "link" link text. Screen reader users can't tell where the link goes.
    learning-room/.github/STUDENT_GUIDE.md
    Fix: Replace with descriptive text like "View keyboard shortcuts guide" or "Download the setup instructions".

  • Missing Image Alt Text
    Images must have descriptive alt text for screen reader users.
    learning-room/.github/STUDENT_GUIDE.md
    Fix: Add descriptive alt text: Description of image

  • Broken Link
    Link points to non-existent file: image.jpg
    learning-room/.github/STUDENT_GUIDE.md
    Fix: Verify the file path is correct or check if the file exists.

  • Broken Link
    Link points to non-existent file: ../docs/guide.md
    learning-room/.github/STUDENT_GUIDE.md
    Fix: Verify the file path is correct or check if the file exists.

  • Broken Link
    Link points to non-existent file: ../docs/guide.md
    learning-room/.github/STUDENT_GUIDE.md
    Fix: Verify the file path is correct or check if the file exists.

  • Broken Link
    Link points to non-existent file: ../docs/markdnown-guide.md
    learning-room/.github/STUDENT_GUIDE.md
    Fix: Verify the file path is correct or check if the file exists.

  • Broken Link
    Link points to non-existent file: ../docs/markdown-guide.md
    learning-room/.github/STUDENT_GUIDE.md
    Fix: Verify the file path is correct or check if the file exists.

Learning Resources

Based on your changes, these guides might help:


Automated validation by Learning Room Bot. Aria generated this review. Last updated: 2026-05-09T17:46:41.827Z
Questions? Check PR Guidelines or mention @Facilitator

Copy link
Copy Markdown

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.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@accesswatch accesswatch closed this pull request by merging all changes into main in a44831b May 10, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Progress Update

Great work, @accesswatch!

Current Level: Explorer
Merged PRs: 12
Next Level: Contributor (NaN more merged PRs)

Available Challenges:

  • 01 Scavenger Hunt
  • 02 First Issue
  • 03 Join Conversation

Keep going!

@accesswatch accesswatch deleted the fix/accessible-table-captions branch May 10, 2026 03:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

accessibility documentation Improvements or additions to documentation needs-work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants