Skip to content

chore: refine authoritative source maps and add validation#205

Merged
accesswatch merged 6 commits into
mainfrom
chore/authoritative-source-validation
May 14, 2026
Merged

chore: refine authoritative source maps and add validation#205
accesswatch merged 6 commits into
mainfrom
chore/authoritative-source-validation

Conversation

@accesswatch
Copy link
Copy Markdown
Collaborator

Summary

  • refine authoritative source map generation for curriculum markdown content
  • add a dedicated validator to enforce required source sections in scoped markdown files
  • add CI workflow to run authoritative source validation on push/PR

Changes

  • scripts/add-authoritative-sources.js
    • improved heading extraction, dedupe, and suppression heuristics for cleaner maps
    • added fallback handling for files without eligible section headings
    • kept generation idempotent for repeatable runs
  • scripts/validate-authoritative-sources.js
    • validates presence of required headings in in-scope markdown files
    • fails with actionable output when required sections are missing
  • package.json
    • added validate:authoritative-sources script
  • .github/workflows/validate-authoritative-sources.yml
    • CI job to enforce validation in pull requests and branch updates

Validation

  • npm run validate:authoritative-sources passed
  • npm run test:automation passed (98/98)
  • podcast/source-map guard check confirmed no authoritative/source-map heading insertions in podcast/script/transcript scope

Notes

  • This commit intentionally isolates automation + CI changes only.
  • Existing unrelated workspace modifications remain unstaged and are not part of this PR.

Copilot AI review requested due to automatic review settings May 14, 2026 15:41
@accesswatch accesswatch requested a review from taylorarndt as a code owner May 14, 2026 15:41
@github-actions
Copy link
Copy Markdown
Contributor

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

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.

Pull request overview

This PR expands the podcast transcript/chapter tooling and adds validation for authoritative-source sections across curriculum Markdown files.

Changes:

  • Adds an authoritative-source validator and CI workflow.
  • Adds transcript chapter-plan JSON sidecars and podcast metadata support for planned chapters.
  • Adds agentic pilot helper tooling for packet generation, transcript evaluation, promotion, and chapter-plan auditing.

Reviewed changes

Copilot reviewed 92 out of 95 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
.github/workflows/validate-authoritative-sources.yml Runs authoritative-source validation in CI.
scripts/validate-authoritative-sources.js Validates required source headings in scoped Markdown content.
package.json Adds validation and podcast helper scripts; updates podcast metadata expected count.
podcasts/tag-audio-metadata.py Adds chapter-plan lookup and conversion to timed chapter markers.
podcasts/README.md Documents chapter-plan and agentic-pilot workflows.
podcasts/tools/agentic-pilot/*.js Adds packet building, promotion, evaluation, normalization, and audit helpers.
podcasts/tools/agentic-pilot/README.md Documents the agentic pilot workflow.
podcasts/logs/agentic-pilots/ep05-working-with-issues-gpt54.txt Adds a pilot rewritten transcript.
podcasts/chapters/ep00-welcome.json Adds a generated chapter sidecar.
podcasts/transcripts/**/*.json Adds generated segment-index chapter plans for companion, appendix, and challenge episodes.

Comment thread package.json
Comment on lines +31 to +32
"podcast:metadata:check": "python podcasts/tag-audio-metadata.py --expected-count 76",
"podcast:metadata:write": "python podcasts/tag-audio-metadata.py --write --expected-count 76",
Comment thread podcasts/README.md
Comment on lines +70 to +74
transcripts/ Derived segment JSON transcripts and chapter plans
chapters/ Podcasting 2.0 chapter JSON sidecars written during metadata tagging
audio/ Local audio output and segment cache, not committed
logs/ Local generation and inventory reports
tools/agentic-pilot/ One-episode packet builder and transcript evaluation helpers
Comment on lines +117 to +125

fs.mkdirSync(path.dirname(scriptPath), { recursive: true });
fs.mkdirSync(transcriptDir, { recursive: true });
fs.writeFileSync(scriptPath, scriptText, 'utf8');
fs.writeFileSync(path.join(transcriptDir, `${args.slug}-segments.json`), JSON.stringify(segments, null, 2) + '\n', 'utf8');

console.log(`Promoted pilot transcript to ${scriptPath}`);
console.log(`Rewrote segments to ${path.join(transcriptDir, `${args.slug}-segments.json`)}`);
console.log('Chapter plan was left unchanged; regenerate or replace it separately if the pilot changed the teaching structure materially.');
@github-actions
Copy link
Copy Markdown
Contributor

Learning Room Validation Report

Great work. Your changes look good.

Resources

@github-actions
Copy link
Copy Markdown
Contributor

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.
  • 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.
  • 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.

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 142)
    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 167)
    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 185)
    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 326)
    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.

  • Heading Hierarchy Skip
    Heading jumps from H2 to H4. This breaks screen reader navigation.
    learning-room/docs/keyboard-shortcuts.md (line 6)
    Fix: Change "H4" to "H3" or add intermediate heading levels.

  • Broken Link
    Link points to non-existent file: htps://nvaccess.org
    learning-room/docs/keyboard-shortcuts.md
    Fix: Verify the file path is correct or check if the file exists.

  • Incomplete Content
    Found 2 [TODO] marker(s). These should be completed before submitting.
    learning-room/docs/setup-guide.md
    Fix: Complete all [TODO] sections with actual content.

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

  • Incomplete Content
    Found 1 [TODO] marker(s). These should be completed before submitting.
    learning-room/docs/welcome.md
    Fix: Complete all [TODO] sections with actual content.

Learning Resources

Based on your changes, these guides might help:


Automated validation by Learning Room Bot. Aria generated this review. Last updated: 2026-05-14T15:45:46.937Z
Questions? Check PR Guidelines or mention @Facilitator

@github-actions github-actions Bot added accessibility documentation Improvements or additions to documentation needs-work labels May 14, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Learning Room Validation Report

Great work. Your changes look good.

Resources

@github-actions
Copy link
Copy Markdown
Contributor

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.
  • 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.
  • 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.

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 142)
    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 167)
    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 185)
    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 326)
    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.

  • Heading Hierarchy Skip
    Heading jumps from H2 to H4. This breaks screen reader navigation.
    learning-room/docs/keyboard-shortcuts.md (line 6)
    Fix: Change "H4" to "H3" or add intermediate heading levels.

  • Broken Link
    Link points to non-existent file: htps://nvaccess.org
    learning-room/docs/keyboard-shortcuts.md
    Fix: Verify the file path is correct or check if the file exists.

  • Incomplete Content
    Found 2 [TODO] marker(s). These should be completed before submitting.
    learning-room/docs/setup-guide.md
    Fix: Complete all [TODO] sections with actual content.

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

  • Incomplete Content
    Found 1 [TODO] marker(s). These should be completed before submitting.
    learning-room/docs/welcome.md
    Fix: Complete all [TODO] sections with actual content.

Learning Resources

Based on your changes, these guides might help:


Automated validation by Learning Room Bot. Aria generated this review. Last updated: 2026-05-14T15:51:01.045Z
Questions? Check PR Guidelines or mention @Facilitator

@github-actions
Copy link
Copy Markdown
Contributor

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.
  • 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.
  • 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.

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 142)
    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 167)
    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 185)
    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 326)
    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.

  • Heading Hierarchy Skip
    Heading jumps from H2 to H4. This breaks screen reader navigation.
    learning-room/docs/keyboard-shortcuts.md (line 6)
    Fix: Change "H4" to "H3" or add intermediate heading levels.

  • Broken Link
    Link points to non-existent file: htps://nvaccess.org
    learning-room/docs/keyboard-shortcuts.md
    Fix: Verify the file path is correct or check if the file exists.

  • Incomplete Content
    Found 2 [TODO] marker(s). These should be completed before submitting.
    learning-room/docs/setup-guide.md
    Fix: Complete all [TODO] sections with actual content.

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

  • Incomplete Content
    Found 1 [TODO] marker(s). These should be completed before submitting.
    learning-room/docs/welcome.md
    Fix: Complete all [TODO] sections with actual content.

Learning Resources

Based on your changes, these guides might help:


Automated validation by Learning Room Bot. Aria generated this review. Last updated: 2026-05-14T15:52:36.674Z
Questions? Check PR Guidelines or mention @Facilitator

@github-actions
Copy link
Copy Markdown
Contributor

Learning Room Validation Report

Great work. Your changes look good.

Resources

@github-actions
Copy link
Copy Markdown
Contributor

Learning Room Validation Report

Great work. Your changes look good.

Resources

@github-actions
Copy link
Copy Markdown
Contributor

Hi! I am Gandalf, your workshop agent. I bring a little magic to make this interaction clear, helpful, and fun. 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.
  • 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.
  • 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.

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 142)
    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 167)
    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 185)
    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 326)
    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.

  • Heading Hierarchy Skip
    Heading jumps from H2 to H4. This breaks screen reader navigation.
    learning-room/docs/keyboard-shortcuts.md (line 6)
    Fix: Change "H4" to "H3" or add intermediate heading levels.

  • Broken Link
    Link points to non-existent file: htps://nvaccess.org
    learning-room/docs/keyboard-shortcuts.md
    Fix: Verify the file path is correct or check if the file exists.

  • Incomplete Content
    Found 2 [TODO] marker(s). These should be completed before submitting.
    learning-room/docs/setup-guide.md
    Fix: Complete all [TODO] sections with actual content.

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

  • Incomplete Content
    Found 1 [TODO] marker(s). These should be completed before submitting.
    learning-room/docs/welcome.md
    Fix: Complete all [TODO] sections with actual content.

Learning Resources

Based on your changes, these guides might help:


Automated validation by Learning Room Bot. Gandalf generated this review. Last updated: 2026-05-14T15:58:38.768Z
Questions? Check PR Guidelines or mention @Facilitator

@accesswatch accesswatch merged commit 897739e into main May 14, 2026
8 of 9 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

Progress Update

Great work, @accesswatch!

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

Available Challenges:

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

Keep going!

@accesswatch accesswatch deleted the chore/authoritative-source-validation branch May 14, 2026 16:30
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