Skip to content

feat: add student course roadmap and Start Here onboarding template#188

Merged
accesswatch merged 1 commit intomainfrom
feat/student-roadmap-onboarding
May 5, 2026
Merged

feat: add student course roadmap and Start Here onboarding template#188
accesswatch merged 1 commit intomainfrom
feat/student-roadmap-onboarding

Conversation

@accesswatch
Copy link
Copy Markdown
Collaborator

Summary

Adds a student-facing course roadmap and onboarding issue template to guide students step-by-step through the full workshop.

Changes

  • \learning-room/docs/course-roadmap.md\ - full step-by-step student guide (Day 1, Day 2, Bonus, support path, completion checklist)
  • \learning-room/.github/ISSUE_TEMPLATE/start-here-roadmap.yml\ - onboarding issue template with canonical absolute URLs to roadmap, challenge hub, solutions, and student guide
  • \learning-room/README.md\ - fixed broken relative paths to challenge hub and workshop docs, added roadmap link
  • \learning-room/.github/STUDENT_GUIDE.md\ - corrected challenge hub path, added roadmap link
  • .github/scripts/tests/challenge-doc-consistency.test.js\ - added 3 new drift gates enforcing roadmap existence, entry-point links, and template resource URLs

Validation

  • Automation: 68/68 pass
  • Classroom self-test: 9/9 pass

… nav fixes

Added:
- learning-room/docs/course-roadmap.md - full step-by-step student guide (Day 1, Day 2, Bonus, support order, completion checklist)
- learning-room/.github/ISSUE_TEMPLATE/start-here-roadmap.yml - onboarding issue template linking roadmap, challenge hub, solutions, student guide via canonical absolute URLs

Fixed:
- learning-room/README.md: broken relative paths to challenge hub and workshop docs
- learning-room/.github/STUDENT_GUIDE.md: corrected challenge hub path, added roadmap link

Tests:
- Added course-roadmap existence and content gate
- Added entry-point link enforcement for README and Student Guide
- Added Start Here template existence and canonical URL gate
- All 68 automation tests pass, classroom self-test 9/9 pass
Copilot AI review requested due to automatic review settings May 5, 2026 04:58
@accesswatch accesswatch requested a review from taylorarndt as a code owner May 5, 2026 04:58
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

Learning Room Validation Report

Great work. Your changes look good.

Resources

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 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 5, 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 [REGISTER] GIT Going with GitHub - March 2026 #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.
  • Tables include proper headers
    Screen readers announce table headers, helping users navigate data.

Accessibility Analysis

  • 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-05T04:59:05.998Z
Questions? Check PR Guidelines or mention @Facilitator

@github-actions github-actions Bot added documentation Improvements or additions to documentation needs-work accessibility labels May 5, 2026
@accesswatch accesswatch merged commit e815609 into main May 5, 2026
11 of 12 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

Progress Update

Great work, @accesswatch!

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

Available Challenges:

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

Keep going!

@accesswatch accesswatch deleted the feat/student-roadmap-onboarding branch May 5, 2026 05:01
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

Adds a student-facing course roadmap and an optional onboarding issue form to the Learning Room template, while updating documentation entry points and adding consistency checks around the new resources.

Changes:

  • Added learning-room/docs/course-roadmap.md as a step-by-step Day 1/Day 2/bonus path for students.
  • Added a new start-here-roadmap.yml issue form and linked the roadmap from the Learning Room README and student guide.
  • Extended challenge-doc-consistency.test.js with new checks for roadmap presence and resource links.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 8 comments.

Show a summary per file
File Description
learning-room/README.md Updates student-facing entry links and adds a roadmap shortcut.
learning-room/docs/course-roadmap.md Introduces the new roadmap document for workshop progression.
learning-room/.github/STUDENT_GUIDE.md Adds roadmap reference and updates challenge hub link.
learning-room/.github/ISSUE_TEMPLATE/start-here-roadmap.yml Adds a new onboarding issue form with resource links.
.github/scripts/__tests__/challenge-doc-consistency.test.js Adds drift checks for roadmap existence and link targets.

Comment on lines +1 to +4
name: "Start Here: Student Course Roadmap"
description: First-stop guide for students to follow setup, challenges, and support resources in order.
title: "Start Here: Student Course Roadmap (@{username})"
labels: ["onboarding", "student"]
Comment thread learning-room/README.md
14. Add a final issue comment with what you learned and your merged PR link

See the [workshop documentation](../../docs/) for full step-by-step guidance.
See the [workshop documentation](../docs/) for full step-by-step guidance.
Comment thread learning-room/README.md
- **Celebrate milestones** (first challenge, Day 1 complete, all challenges complete)

[**View Available Challenges →**](docs/CHALLENGES.md)
[**View Available Challenges →**](../docs/CHALLENGES.md)
Comment on lines +16 to +18
1. Read the [Setup Guide](setup-guide.md).
2. Open the [Challenge Hub](../../docs/CHALLENGES.md).
3. Keep the [Keyboard Shortcuts](keyboard-shortcuts.md) page open if useful.
- [Markdown Reference (Appendix C)](https://github.com/Community-Access/git-going-with-github/blob/main/docs/appendix-c-markdown-reference.md)
- [Accessibility Standards (Appendix M)](https://github.com/Community-Access/git-going-with-github/blob/main/docs/appendix-m-accessibility-standards.md)
- [Challenge Hub](../docs/CHALLENGES.md)
- [Challenge Hub](../../docs/CHALLENGES.md)
Comment on lines +190 to +199
assert.match(
readme,
/\[\*\*View Available Challenges →\*\*\]\(\.\.\/docs\/CHALLENGES\.md\)/,
'learning-room/README.md should link to canonical challenge hub path'
);

assert.match(
studentGuide,
/\[Course Roadmap\]\(\.\.\/docs\/course-roadmap\.md\)/,
'learning-room/.github/STUDENT_GUIDE.md should link to course roadmap'
Comment thread learning-room/README.md
## How to Contribute

1. Open the canonical challenge list: `docs/CHALLENGES.md`
1. Open the canonical challenge list: `../docs/CHALLENGES.md`
- Completed capstone challenge (16)
- Optional: completed bonus challenges (A-E)

When in doubt, return to the [Challenge Hub](../../docs/CHALLENGES.md). It is the canonical challenge reference.
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