Skip to content

Make the template classroom-ready on Windows - #3

Merged
jbj merged 3 commits into
mainfrom
jbj/classroom-readme
Nov 9, 2026
Merged

jbj merged 3 commits into
mainfrom
jbj/classroom-readme

Conversation

@jbj

@jbj jbj commented Nov 8, 2026

Copy link
Copy Markdown
Owner

Closes #

What changed

  • Rework the README for first-time GitHub users working in the Copilot App, with Windows setup steps and maintainer guidance separated.
  • Make screenshot verification discover Chrome/Chromium and ImageMagick on Windows and Linux, and fix Windows path handling in the browser harness.
  • Add a manually triggered Windows Actions verification job and normalize checkout line endings so formatting checks behave consistently across platforms.

Why

The template is intended for a classroom where students are new to Git and GitHub and use Windows, while the teacher develops on Linux and CI remains on Ubuntu. The previous README assumed technical Git knowledge, and the full local verification path relied on Linux-specific tooling.

Checklist

  • npm run verify passes (Linux: NO_PROXY=127.0.0.1,localhost npm run verify; Linux and Windows Actions both passed in run 42523321519)
  • Any design invariant this changes is documented in its Markdown file and called out above (no product design invariant changed)
  • The screenshots below come from this branch

Screenshots

N/A - this change updates documentation and verification tooling; it does not change the app's visuals. The branch's CI run generated screenshot artifacts.

jbj and others added 2 commits November 8, 2026 21:49
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 8, 2026 21:10

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Manual verification can cancel deployment-gating push CI and leave commits unpublished, while Windows PATH handling and the shot-sheet entrypoint guard also prevent verification and sheet generation.

3 open issues
What changed in this PR

This PR prepares the TypeScript/Vite template for Windows-based classrooms while retaining Linux development and CI support.

Changes:

  • Reworks onboarding for first-time GitHub users and separates maintainer guidance.
  • Adds cross-platform screenshot-tool discovery, Windows path handling, and discovery tests.
  • Adds manually triggered Windows verification and normalizes checkout line endings.
File Description
tests/​platform-tools.test.mjs Tests browser and ImageMagick discovery.
scripts/​tools.mjs Adds cross-platform ImageMagick detection and setup guidance.
scripts/​shot.mjs Makes build-directory containment checks Windows-compatible.
scripts/​shot-sheet.mjs Adds Windows installation guidance to the error message.
scripts/​chrome.mjs Finds standard Windows Chrome installations and updates diagnostics.
README.md Introduces beginner-focused onboarding and separate maintainer steps.
docs/​code.md Documents Windows/Linux setup and PowerShell-compatible commands.
.github/​workflows/​ci.yml Adds manual Windows verification and screenshot artifacts.
.github/​rulesets/​README.md Makes command examples PowerShell-compatible.
.github/​copilot-instructions.md Records platform support and routes setup guidance.
.gitattributes Enforces LF checkout line endings for text files.

Review effort: Balanced

Comment thread .github/workflows/ci.yml Resolved
Comment thread .github/workflows/ci.yml Resolved
Comment thread scripts/shot-sheet.mjs Resolved
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 9, 2026 15:47

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are reported for the Windows classroom setup and cross-platform verification changes.

No open issues 🎉

3 resolved since last review

Review effort: Balanced

@jbj
jbj merged commit e6be963 into main Nov 9, 2026
2 checks passed
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