docs: resolve open issues 221/229/231 and retire stale Classroom seeding references#241
Merged
Conversation
…ing references - Ch11 (#231): replace the Five Major Regions ASCII diagram with a real markdown table; screen readers were announcing the box-drawing pipes as broken tables. - Ch6 (#229): add a Steps Using the Web Editor subheading plus screen reader and sighted learning cards for the first web-editor challenge: file navigation, the E and period shortcuts, finding the Commit changes button, and a github.dev-is-VS-Code note linking Chapters 11 and 12. - Appendix Z (#221): add GitHub's learning portal (learn.github.com) to Additional Resources with an accessibility note. - HUMAN_TEST_MATRIX, classroom README, GO-LIVE guide, E2E QA runbook: status notes explaining that scripts/classroom/ was removed and that the Student Progression Bot now seeds peer simulation artifacts automatically; seeding steps rewritten as workflow dispatches. - build-html.js: exclude gold.md (private maintainer log) from the public site; validate-authoritative-sources.js: exclude it from content checks; .gitignore it so it never lands in the public repo. - html/ regenerated. Closes #221, closes #229, closes #231. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
Peer Review AssignedHi @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:
Accessibility:
Documentation:
Review Guidelines:
Resources: Pairing by Learning Room Grouping Engine |
There was a problem hiding this comment.
Pull request overview
Updates curriculum docs and operational guides to resolve issues #221/#229/#231, improve accessibility, and retire stale references around learning-room seeding while also preventing a private maintainer log (gold.md) from being published/validated.
Changes:
- Improves accessibility and clarity in multiple curriculum chapters (tables/learning cards/links).
- Updates facilitator/runbook documentation with “post-Classroom” status notes and revised seeding guidance.
- Adjusts HTML build + validation tooling to exclude
gold.md, and regenerates committedhtml/output.
Reviewed changes
Copilot reviewed 17 out of 19 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/validate-authoritative-sources.js | Excludes gold.md from authoritative-source validation targets. |
| scripts/build-html.js | Excludes gold.md from the public HTML build input set. |
| .gitignore | Ignores gold.md to reduce risk of accidental publication. |
| docs/11-vscode-interface.md | Replaces ASCII layout diagram with an accessible Markdown table. |
| docs/06-working-with-pull-requests.md | Adds a “Steps Using the Web Editor” subheading + learning cards for web editing. |
| docs/appendix-z-github-skills.md | Adds learn.github.com to additional resources with an accessibility note. |
| GO-LIVE-QA-GUIDE.md | Adds a post-Classroom status note; updates seeding checklist wording. |
| classroom/README.md | Adds post-Classroom status note; updates peer-simulation seeding guidance. |
| classroom/HUMAN_TEST_MATRIX.md | Rewrites seeding steps to use Student Progression Bot workflow dispatch. |
| admin/LEARNING-ROOM-E2E-QA-RUNBOOK.md | Adds post-Classroom status note at the top of the runbook. |
| html/docs/11-vscode-interface.html | Regenerated HTML reflecting the Chapter 11 table change. |
| html/docs/06-working-with-pull-requests.html | Regenerated HTML reflecting Chapter 6 learning cards/subheading. |
| html/docs/appendix-z-github-skills.html | Regenerated HTML reflecting added learning-portal link. |
| html/GO-LIVE-QA-GUIDE.html | Regenerated HTML reflecting status note + seeding checklist updates. |
| html/classroom/README.html | Regenerated HTML reflecting classroom guide updates. |
| html/classroom/index.html | Regenerated HTML reflecting classroom guide updates. |
| html/classroom/HUMAN_TEST_MATRIX.html | Regenerated HTML reflecting human test matrix updates. |
| html/admin/LEARNING-ROOM-E2E-QA-RUNBOOK.html | Regenerated HTML reflecting runbook status note updates. |
| html/search-index.json | Regenerated search index reflecting updated/reshuffled HTML corpus. |
Comments suppressed due to low confidence (1)
admin/LEARNING-ROOM-E2E-QA-RUNBOOK.md:9
- The status note correctly says GitHub Classroom was removed, but the immediate checklist below still lists "GitHub Classroom deployment and assignment setup". Updating the numbered list (and nearby scope wording) to reflect hybrid provisioning + workflow dispatches will keep the runbook internally consistent.
> **Status note (2026-07):** GitHub Classroom and the `scripts/classroom/` PowerShell tooling were removed. Provisioning is the hybrid pipeline in `.github/scripts/provisioning/` (workflow `provision-learning-rooms.yml`), and peer simulation artifacts are seeded automatically by the Student Progression Bot in each learning room. Interpret `scripts/classroom/*.ps1` steps below as the Student Progression Bot workflow dispatch (inputs `start_challenge`, `assignee`); `Seed-PeerSimulation.ps1` steps need no action because the bot seeds and self-repairs those artifacts.
Use this runbook when you want one operational checklist that covers the full workflow:
1. Registration intake and validation.
2. GitHub Classroom deployment and assignment setup.
3. Test account acceptance and repository seeding.
Comment on lines
+971
to
+975
| // gold.md is a private maintainer log; keep it out of the public site. | ||
| const relative = path.relative(process.cwd(), filePath).replace(/\\/g, '/'); | ||
| if (relative !== 'gold.md') { | ||
| fileList.push(filePath); | ||
| } |
Comment on lines
+3
to
7
| > **Status note (2026-07):** GitHub Classroom and the `scripts/classroom/` PowerShell tooling described in this guide have been removed. Current cohorts use hybrid provisioning (`.github/scripts/provisioning/`, triggered by the `provision-learning-rooms.yml` workflow), and peer simulation artifacts are seeded automatically by the Student Progression Bot inside each learning room. Where this guide references a `scripts/classroom/*.ps1` script, use the Student Progression Bot's **Run workflow** dispatch (inputs `start_challenge` and `assignee`) instead. This guide is retained for the parts that are still accurate (challenge flow, bots, grading). | ||
|
|
||
| > Single, end-to-end guide for deploying a new Git Going with GitHub workshop cohort. Covers everything from creating the classroom through post-workshop teardown. This is the only deployment document you need. | ||
|
|
||
| > Before sharing invite links with students, complete the [Go-Live QA Guide](../GO-LIVE-QA-GUIDE.md). It is the final release gate for content, workflows, Classroom setup, podcasts, accessibility, and human test coverage. |
Comment on lines
244
to
248
| ### Seeding Scripts | ||
|
|
||
| - [ ] `Seed-LearningRoomChallenge.ps1` creates the requested starting challenge. | ||
| - [ ] `Seed-PeerSimulation.ps1` creates the peer simulation issues, branch, file, and PR. | ||
| - [ ] Student Progression Bot workflow dispatch creates the requested starting challenge. | ||
| - [ ] The progression bot seeds the peer simulation issues, branch, file, and PR automatically alongside the challenge issue. | ||
| - [ ] `Start-MergeConflictChallenge.ps1` creates a real conflict against the student branch. |
Comment on lines
18
to
+22
| ## Required Facilitator Setup | ||
|
|
||
| After the student repository exists, run: | ||
| The old `scripts/classroom/` PowerShell seeding scripts were removed with GitHub Classroom. Seeding now runs through the Student Progression Bot workflow inside the student repository. | ||
|
|
||
| ```powershell | ||
| scripts/classroom/Seed-LearningRoomChallenge.ps1 -Repository Community-Access/learning-room-smoke-a -Challenge 1 -Assignee test-student-a | ||
| scripts/classroom/Seed-PeerSimulation.ps1 -Repository Community-Access/learning-room-smoke-a -StudentUsername test-student-a | ||
| ``` | ||
| After the student repository exists, open the repo's Actions tab, choose **Student Progression Bot**, select **Run workflow**, and set: |
Comment on lines
268
to
272
| ### Seeding peer simulation | ||
|
|
||
| Because each GitHub Classroom repository is private, students cannot automatically see a classmate's issues or pull requests. To preserve realistic collaboration without exposing private student repos, seed peer-simulation artifacts into each student's repository: | ||
|
|
||
| ```powershell | ||
| scripts/classroom/Seed-PeerSimulation.ps1 -Repository Community-Access-Classroom/learning-room-studentname -StudentUsername studentname | ||
| ``` | ||
| Because each learning room repository is private, students cannot automatically see a classmate's issues or pull requests. To preserve realistic collaboration without exposing private student repos, peer-simulation artifacts are seeded into each student's repository automatically: the Student Progression Bot creates them the first time it opens a challenge issue, and repairs them on later runs if any are missing. No facilitator action is required. | ||
|
|
||
| This creates two peer-simulation issues and one peer-simulation pull request. Challenges that ask students to comment, react, review, compare, or practice peer collaboration can use those seeded artifacts. If facilitators intentionally provision real buddy access, students may use real buddy repositories instead. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
markdown table; screen readers were announcing the box-drawing pipes as
broken tables.
reader and sighted learning cards for the first web-editor challenge:
file navigation, the E and period shortcuts, finding the Commit changes
button, and a github.dev-is-VS-Code note linking Chapters 11 and 12.
Additional Resources with an accessibility note.
status notes explaining that scripts/classroom/ was removed and that
the Student Progression Bot now seeds peer simulation artifacts
automatically; seeding steps rewritten as workflow dispatches.
site; validate-authoritative-sources.js: exclude it from content checks;
.gitignore it so it never lands in the public repo.
Closes #221, closes #229, closes #231.
Co-Authored-By: Claude Fable 5 noreply@anthropic.com