-
Notifications
You must be signed in to change notification settings - Fork 0
Deploy education directory to GitHub Pages #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: thinksyncs <42225585+thinksyncs@users.noreply.github.com>
Co-authored-by: thinksyncs <42225585+thinksyncs@users.noreply.github.com>
There was a problem hiding this 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 an automated GitHub Pages deployment pipeline for the education/ materials so the quiz and related static assets can be published from the repository.
Changes:
- Added a GitHub Actions workflow to deploy the
education/directory to GitHub Pages on pushes tomain(and via manual trigger). - Added
education/README.mdwith deployment/setup and local usage instructions. - Updated root
README.mdto mention theeducation/directory and Pages link.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.github/workflows/deploy-pages.yml |
New Pages deployment workflow that uploads education/ as the Pages artifact and deploys it. |
education/README.md |
Documents what’s in education/ and how Pages deployment works. |
README.md |
Adds education/ to the project structure section and links to the Pages site. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `toppy-gw`: A lightweight QUIC + HTTP/3 gateway (QUIC ping + CONNECT-UDP echo/forward). | ||
| - `toppy-core`: Shared functionality, including configuration management, policy enforcement, and logging. | ||
| - `toppy-proto`: Definitions of the custom capsule/command messages used between client and gateway. | ||
| - `education`: Educational materials and quizzes (deployed to [GitHub Pages](https://thinksyncs.github.io/toppy/)). |
Copilot
AI
Feb 2, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This list is introduced as “multiple crates”, but education is not a Cargo crate/module. Consider moving it to a separate “Other directories” list or explicitly labeling it as non-crate content to avoid confusing workspace structure.
| - `toppy-gw`: A lightweight QUIC + HTTP/3 gateway (QUIC ping + CONNECT-UDP echo/forward). | ||
| - `toppy-core`: Shared functionality, including configuration management, policy enforcement, and logging. | ||
| - `toppy-proto`: Definitions of the custom capsule/command messages used between client and gateway. | ||
| - `education`: Educational materials and quizzes (deployed to [GitHub Pages](https://thinksyncs.github.io/toppy/)). |
Copilot
AI
Feb 2, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The link points to the Pages site root (https://thinksyncs.github.io/toppy/), but the deployed artifact contains quiz_template_skeleton.html and no index.html, so the root URL will likely 404. Either link directly to the quiz page or add an education/index.html landing page (e.g., redirect / links).
| - `education`: Educational materials and quizzes (deployed to [GitHub Pages](https://thinksyncs.github.io/toppy/)). | |
| - `education`: Educational materials and quizzes (deployed to [GitHub Pages](https://thinksyncs.github.io/toppy/quiz_template_skeleton.html)). |
|
|
||
| These HTML files are automatically deployed to GitHub Pages when changes are pushed to the `main` branch. | ||
|
|
||
| Access the quiz at: `https://thinksyncs.github.io/toppy/quiz_template_skeleton.html` |
Copilot
AI
Feb 2, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This hard-codes the Pages URL to a specific owner/repo. For forks/renames/custom domains this will be incorrect; consider documenting the generic URL pattern (https://<owner>.github.io/<repo>/...) and/or using a relative link to the deployed file (e.g., ./quiz_template_skeleton.html) alongside the canonical URL.
| Access the quiz at: `https://thinksyncs.github.io/toppy/quiz_template_skeleton.html` | |
| Access the quiz via GitHub Pages at a URL of the form `https://<owner>.github.io/<repo>/quiz_template_skeleton.html`. For this repository, that is `https://thinksyncs.github.io/toppy/quiz_template_skeleton.html`. When browsing the deployed site, you can also use the relative link `./quiz_template_skeleton.html`. |
Adds automated GitHub Pages deployment for educational materials in the
education/directory.Changes
GitHub Actions workflow (
.github/workflows/deploy-pages.yml)education/directory on push tomainor manual triggereducation/**Documentation
education/README.md: Deployment info and local dev instructionsREADME.md: Added education directory to project structurePost-merge setup
Repository Settings → Pages → Source: GitHub Actions
Quiz accessible at:
https://thinksyncs.github.io/toppy/quiz_template_skeleton.htmlOriginal prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.