Skip to content

Harden challenge quality gates, consistency checks, and student support docs#187

Merged
accesswatch merged 36 commits intomainfrom
build/curriculum-v2
May 5, 2026
Merged

Harden challenge quality gates, consistency checks, and student support docs#187
accesswatch merged 36 commits intomainfrom
build/curriculum-v2

Conversation

@accesswatch
Copy link
Copy Markdown
Collaborator

Summary

This PR hardens Learning Room production readiness by adding test-enforced quality gates, cross-doc drift checks, workflow resilience updates, and student-facing support documentation.

What changed

  1. Added challenge template quality gate tests for all 21 challenge/bonus templates.
  2. Added challenge-doc consistency gate tests against Challenge Hub and facilitator matrix/docs.
  3. Hardened learning-room workflows with concurrency/timeouts and safer comment-responder gating.
  4. Fixed classroom E2E report filename sanitization for safe local self-test output.
  5. Added student-facing Learning Room solutions index.
  6. Added curated Skills-inspired bonus scenarios with source attribution.
  7. Updated challenge and learning-room docs to reference the new local support resources.

Validation run

  • npm run test:automation -> passing (65 tests)
  • pwsh -NoProfile -File scripts/classroom/Invoke-LearningRoomEndToEndTest.ps1 -SelfTest -Quiet -> passing (9/9)

Risk and rollout

  • No changes to official challenge count or progression model (16 core + 5 bonus unchanged).
  • New gates reduce future drift and regressions across templates/docs/workflows.
  • Merge via protected branch flow to preserve governance and CI checks.

GitHub Workshop Bot added 30 commits March 9, 2026 15:15
Comprehensive plan to restructure chapters and appendices:
- Align chapter file numbers with teaching order
- Eliminate redundancy between chapters and appendices
- Consolidate 31 appendices to 26 grouped into 6 domains
- Add learning cards and authoritative source attribution
- Dense cross-linking and 7-phase implementation roadmap
Merges the curriculum restructure and classroom delivery plans into one
coherent document. Key changes from the previous plan:

- Unified vision: maps 22 chapters to 16 challenges + 5 bonus
- Five new chapters: Tool Tour, Git Mental Model, Fork Workflow,
  Capstone (standalone), and Next Steps
- 26 appendices (A-Z) organized into 6 domains, no AA-AE overflow
- Failsafe design system adopted from classroom plan into every chapter
- Learning cards (250-300 sets) and tool cards (80+) standardized
- Resolved decisions section covering capstone PR targets, peer review,
  post-workshop iteration, and the two-repository model
- 7-phase implementation roadmap with weekly milestones
- Authoritative source registry with 60+ canonical documentation links
- Complete file rename map and consolidation ledger
…tegy

New sections added to the curriculum master plan:

- Challenge Artifacts and Solution Files (section 8): complete inventory
  of every file the learning-room needs before students arrive -- starter
  files, issue templates, autograding workflows, sample files, and 21
  annotated solution files in docs/solutions/ for student self-check
- GitHub Skills Integration Strategy (section 14): extends the Day 1
  two-track model (Mona + learning-room) to Day 2 with 3 new courses
  (Introduction to Git, Getting Started with Copilot, Copilot Code Review)
- Phase 7 expanded from 7 to 40+ checklist items covering issue templates,
  autograders, solution files, GitHub Skills Day 2, and e2e verification
- Summary table updated with new artifact counts
…, Phase 8

New sections and updates to the curriculum master plan:

- GitHub Classroom Setup Artifacts (section 9): classroom/ directory spec
  with copy-paste assignment descriptions, autograding JSON configs,
  roster template, setup/teardown guides, and 4 automation scripts
- Supplementary File Rebuild Inventory (section 10): catalogs all 61+
  files that must be rewritten after curriculum content is final --
  28 root ops files, 6 learning-room guides, 6 validation scripts,
  11 workflows, 4 data files, 6 test files, podcast manifest
- Phase 8 added (Weeks 10-12): 77 checklist items for classroom
  artifacts and supplementary rebuild, executed only after Phases 1-7
- Resolved Decision 6: chapters stay in ggg repo, Classroom gets
  assignment descriptions that link to chapters
- Implementation roadmap updated from 7 to 8 phases
- Summary table updated with classroom file counts and rewrite totals
- TOC expanded to 22 entries
- Add course-guide.md to supplementary rebuild inventory (Category 1)
  and Phase 8 checklist -- it references every chapter/appendix number
- Add appendix-ae-github-social.md to Files Deleted After Merge table
  (was missing; content merges into Appendix T)
- Clarify Summary table: 49 = 22 ch + 26 app + course-guide
…dices

Structural reorganization of the entire curriculum:

Chapters (17 -> 22):
- Split Ch05 (VS Code) into Ch11 (Interface) + Ch12 (Accessibility)
- Merged Ch12 (PR Extension) + Ch14 (Accessible Code Review) into Ch15
- Created 5 new stubs: Ch01 (Tool Tour), Ch13 (Git Mental Model),
  Ch18 (Fork Workflow), Ch20 (Capstone), Ch21 (Next Steps)
- Renamed 10 chapters to align with Day1=00-10, Day2=11-21

Appendices (31 -> 26, A-Z):
- Merged R+S+AE into T (Community and Social)
- Merged G+F into U (Discussions and Gists)
- Merged W+X into K (Copilot Reference)
- Absorbed App T (Contributing) into Ch08 (Open Source Culture)
- Renamed all 26 appendices to sequential A-Z letters
- Organized into 6 domains in course-guide.md

Cross-references:
- 249 filename references updated across 55 files
- Zero stale references outside REORGANIZATION-PLAN.md
- Zero broken internal links
- course-guide.md rewritten with complete new structure
- All 48 Phase 1 items marked complete in todo.md
Five stub chapters replaced with full content:

- Ch01 Choose Your Adventure (tool tour): 5 paths (GitHub.com, github.dev,
  VS Code, GitHub Desktop, GitHub CLI), screen reader and low-vision
  guidance per path, Day 1/Day 2 recommendations, confidence exercise
- Ch13 How Git Works (mental model): three areas, commits, branches,
  local vs remote, push/pull/fetch, merge conflicts, Git timeline,
  diagram-free screen-reader-friendly explanations grounded in Pro Git
- Ch18 Fork and Contribute (open source workflow): 8-step walkthrough
  from fork to merged PR, multi-tool instructions (VS Code, Desktop,
  CLI, browser), upstream remote setup, fork sync, cleanup checklist
- Ch20 Build Your Agent (capstone): 6 phases from idea to merged PR,
  agent file template, responsibilities/guardrails writing guide,
  60-point autograded rubric, 3 example agents, testing checklist
- Ch21 What Comes Next (graduation): skills inventory, portfolio guide,
  continued learning roadmap, 6 GitHub Skills courses, community
  connection points, contributing back workflow

All 5 Phase 2 items marked complete in todo.md.
New sections added to fill identified content gaps:

- Ch05: Writing Effective Issues (~95 lines)
- Ch06: Writing PR Descriptions That Get Reviewed (~115 lines)
- Ch08: Writing Your First README + Community Health Files (~120 lines)
- Ch10: What You Accomplished Today + What Day 2 Adds (~84 lines)
- Ch12: Markdown Authoring in VS Code, Section 19 (~105 lines)
- Ch15: The Reviewer's Craft, Part 4 (~110 lines)
- Ch16: Critically Evaluating AI Output, Section 13 (~100 lines)

All 7 Phase 3 items marked complete in todo.md. +683 lines total.
Added tri-audience learning cards (screen reader, low-vision, sighted)
to all major sections in Day 1 chapters. Each card set provides 3-6
specific, actionable tips per audience for the section's content.

Files: Ch00 through Ch10 (11 files), +1363 lines
Added tri-audience learning cards (screen reader, low-vision, sighted)
to all major sections in Day 2 chapters. Same format as batch 1.

Files: Ch11 through Ch21 (10 files, Ch21 had no major sections), +1218 lines
… Git)

Tri-audience learning cards added to all major sections in appendices
A (Glossary), B (Screen Reader), C (Markdown), D (Git Auth), E (Advanced
Git), F (Git Security).
…e + Copilot)

Tri-audience learning cards added to appendices G (VS Code Ref),
H (GitHub Desktop), I (GitHub CLI), J (Cloud Editors), K (Copilot Ref),
L (Agents Ref).
… Platform)

Tri-audience learning cards added to appendices M (Accessibility Standards),
N (Advanced Search), O (Branch Protection), P (Security Features),
Q (Actions Workflows), R (Projects), S (Releases Tags Insights).
…ity + Continuing)

Tri-audience learning cards added to appendices T (Community and Social),
U (Discussions and Gists), V (GitHub Mobile), W (GitHub Pages),
X (Resources), Y (Workshop Materials), Z (GitHub Skills).

Phase 4 complete: 177 learning card sets added across 47 files.
Added cards to sections that teach hands-on skills with genuine
audience differentiation: navigating lists, filtering, commenting,
cross-referencing, sub-issues, managing, good-first-issue labels,
accessibility issue writing, and filing first issue.

Total in file: 13 card sets (up from 5).
…3 files

Added learning cards only where they genuinely add value: sections
that teach hands-on skills with real audience differentiation.

Chapters (17 cards): Ch06 (navigating, checks, review, suggestions),
Ch08 (fork sync, README, finding work), Ch15 (VS Code review, merging,
GitHub.com), Ch16 (agent mode, GitHub.com, accessible view), Ch17
(a11y bug template, hands-on), Ch19 (contributing, tools), Ch21
(portfolio, contributing back).

Appendices (16 cards): C (links, images, tables, collapsible), K
(custom instructions, agentic), L (agent.md, hooks), S (releases,
contributors), T (stars, watching), U (discussions, gists).

Total curriculum: 218 quality card sets.
…ing, URLs

Phase 5 (Tool Cards and Failsafe Sections):
- Multi-tool-path cards in all Day 1 and Day 2 chapters
- Failsafe tables in all 22 chapters

Phase 6 (Cross-Linking and Attribution):
- Header blocks on all 48 files (chapters + appendices)
- Prev/next footer navigation on all 48 files
- 34 inline forward/back cross-references
- Challenge callouts in 10 chapters
- TOC added to Ch12
- All 63 authoritative source URLs verified, 5 broken links fixed
- Phase 5 and Phase 6 checkboxes updated in plan and todo
Code review fixes:
- Fix missing await on github.rest.issues.createComment (learning-room-validation.yml)
- Fix wrong Python script paths in learning-room-validation.yml
- Fix stale appendix references (appendix-e -> appendix-c, appendix-c -> appendix-m)
- Fix stale doc reference (07-culture-etiquette -> 08-open-source-culture)

File cleanup:
- Remove misplaced Python scripts from .github/workflows/
- Remove superseded planning docs and summaries
- Remove consolidated standalone docs (AUTOMATION.md, GROUP_CHALLENGES.md, LEARNING_PATHS.md)
- Remove stale HTML renderings of deleted source files

New content:
- Add classroom/ directory (8 files: GitHub Classroom integration)
- Add 21 challenge issue templates for learning room
- Add 21 solution guides in docs/solutions/
- Add 4 autograder workflows and learning room sample files

Updates across 37 existing files:
- Update all stale cross-references to match new chapter numbering
- Rewrite challenge-progression.json for 16+5 challenge structure
- Update README.md, learning room operational docs, JS scripts, YAML workflows

All 47 tests pass.
- added Capstone Connection to Ch02
- added Agentic Strategy boxes to Ch05, 06, 07, 09
- reframed manual git tasks as preparations for building an AI agent
- give the PR bot a friendly persona (Aria)
- change auto-responses to be warm, encouraging and teacher-like
- directly reference the Capstone agent in the welcome message
- added 'welcome-issue-timer' job to learning-room-pr-bot.yml
- triggers when a user opens their first issue (Chapter 5)
- Aria congratulates them and reminds them an issue is an AI prompt
- Moved CHALLENGES.md from learning-room up to the root docs folder to separate Instruction Manual from Sandbox`n- Added explicit 'Next Step / Challenge Time' breadcrumbs to bottom of all Day 1 chapters
- Re-styled Aria's Validation Report to praise the student and tell them what chapter to read next
- Added COHORT_PROVISIONING.md instructions for replicating cleanly
- Updated powershell API scripts to accept -TargetRepo argument instead of hardcoding
- Clarified the template-driven strategy so student branches don't pile up
- Added readme ref
- Pointed instructions to a dedicated template repository so active workshop isn't disrupted
- cleaned up root directory by consolidating planning and management files
- updated README.md and classroom docs to point to the new admin/ directory context.
- finalized remaining orphan references.
- Explicitly state in classroom/README.md that the Web GUI must be used.
- This addresses user questions about why gh classroom can't automate it.
GitHub Workshop Bot added 6 commits March 17, 2026 11:17
- Create Day 2 Quick Start guide for participants joining without Day 1
- Restructure Day 2 Block 0 with parallel onboarding tracks
- Soften Day 2 premise to acknowledge both entry paths
- Replace hard Day 1 assumptions with chapter references
- Make Day 1 wrap-up self-contained with dual closing sections
- Add prerequisites table to Day 2 Agenda
- Populate Day 1 Classroom assignment (was empty)
- Update Day 2 Classroom assignment for Day-2-only joiners
- Document two participation paths in Classroom README
- Update grading guide completion levels for Day-2-only participants
- Remove ENROLLMENT_SUMMARY.html and WORKSHOP_READINESS.html from search index
- Templatize hardcoded dates in workshop-registration.yml and feedback-workshop.yml
- Generalize DEPLOYMENT_VALIDATION.md sign-off section with placeholders
- Fix 298 markdown lint errors in VALIDATION_AUDIT.md (MD009, MD012, MD019, MD022, MD026, MD029, MD031, MD032, MD040)
- Fix 82 markdown lint errors in DEPLOYMENT_VALIDATION.md
- Delete legacy scripts, one-time cohort files, and generated HTML artifacts
- Rewrite admin docs for GitHub Classroom + Aria + Progression Bot model
- Templatize dates across agendas, announcements, and registration files
- Unify deployment guide in classroom/README.md
Copilot AI review requested due to automatic review settings May 5, 2026 04:38
@accesswatch accesswatch requested a review from taylorarndt as a code owner May 5, 2026 04:38
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 wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

@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

@accesswatch accesswatch merged commit 6ed0cd4 into main May 5, 2026
3 checks passed
@accesswatch accesswatch deleted the build/curriculum-v2 branch May 5, 2026 04:48
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.

2 participants