Repository navigation
Make the template classroom-ready on Windows - #3
Merged
Merged
Conversation
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟡 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
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.


Closes #
What changed
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 verifypasses (Linux:NO_PROXY=127.0.0.1,localhost npm run verify; Linux and Windows Actions both passed in run 42523321519)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.