Update READMEs and document GitHub Pages publishing - #6
Merged
Conversation
Co-authored-by: charles2ke <6725706+charles2ke@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
charles2ke
August 27, 2026 11:52
View session
charles2ke
approved these changes
Aug 27, 2026
There was a problem hiding this comment.
🟡 Changes recommended
The PR is described as documentation-only, but it also modifies website/package-lock.json, which should be reverted or explicitly justified/declared.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates repository documentation to better describe the learning website and its GitHub Pages deployment, replacing the default Vite template docs under website/.
Changes:
- Refreshes
README.mdto surface the live Pages URL and document thewebsite/structure + Pages workflow behavior. - Rewrites
website/README.mdwith project-specific development, scripts, and deployment guidance. - Includes non-documentation changes in
website/package-lock.json(lockfile metadata edits).
File summaries
| File | Description |
|---|---|
| README.md | Adds live site URL and expands documentation for the website + Pages publishing workflow. |
| website/README.md | Replaces stock Vite README with development/scripts/deployment documentation for the website. |
| website/package-lock.json | Lockfile changes unrelated to the stated documentation-only scope. |
Review details
Files not reviewed (1)
- website/package-lock.json: Generated file
- Files reviewed: 2/3 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
156
to
160
| "arm64" | ||
| ], | ||
| "dev": true, | ||
| "libc": [ | ||
| "glibc" | ||
| ], | ||
| "license": "MIT", | ||
| "optional": true, |
Comment on lines
+45
to
+47
| The `.github/workflows/deploy-pages.yml` workflow runs this build and publishes | ||
| `dist/` to GitHub Pages on every push to `main` that touches `website/`, and on | ||
| manual dispatch. |
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.
The READMEs did not reflect the current state of the project: the root README under-documented the website and its Pages deployment, and
website/README.mdwas still the stock Vite template. The learning website itself is already published by.github/workflows/deploy-pages.yml, whose latest run onmaindeployed successfully to https://charles2ke.github.io/GraphQL/ — no workflow changes were required.README.mdwebsite/(App,backendSamples.js, Vite config) and.github/workflows/deploy-pages.yml.maintouchingwebsite/, plus manual dispatch) and that the workflow enables Pages / switches the source to Actions itself, so no manual repo setup is needed.npm run previewandnpm run lintnext to the existingGITHUB_PAGES=true npm run build.website/README.md4000,VITE_GRAPHQL_URLoverride, a scripts table, and howGITHUB_PAGES=truesets the Vitebaseto/GraphQL/to match the project Pages URL.Documentation-only; no source or workflow files touched.