docs: rewrite GitHub Pages enable steps for a fork - #240
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the contributing documentation to provide clearer, current UI-aligned steps for enabling GitHub Pages on a fork so contributors can preview changes (addressing #234).
Changes:
- Replaces the old prose paragraph with a numbered, step-by-step workflow for enabling Pages via Settings → Pages.
- Updates wording to match the current “Deploy from a branch” GitHub Pages configuration flow.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Suppressed comments (2)
Development/Contributing-to-Heads-Wiki.md:112
- Capitalize "github" to "GitHub" for consistency and correctness.
Please note that the URL is similar but NOT the same as the wiki pages feature in your fork in github.
### Verifying broken links
Please verify `https://YOUR_USERNAME_HERE.github.io/YOUR_FORK_REPO_NAME/` with `https://validator.w3.org/checklink` before pushing your changes.
Development/Contributing-to-Heads-Wiki.md:112
- Remove the trailing whitespace at end of line (keeps diffs clean and avoids markdown lint noise).
Please verify `https://YOUR_USERNAME_HERE.github.io/YOUR_FORK_REPO_NAME/` with `https://validator.w3.org/checklink` before pushing your changes.
tlaurion
added a commit
that referenced
this pull request
Aug 31, 2026
tlaurion
force-pushed
the
fix/pages-steps-234
branch
from
August 31, 2026 21:38
3ed0256 to
c592094
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
Development/Contributing-to-Heads-Wiki.md:111
- The Wiki URL example hard-codes
heads-wiki, but earlier steps correctly generalize that forks may have different repo names. This example should useYOUR_FORK_REPO_NAMEso readers with renamed forks don’t end up on the wrong URL.
> (`https://github.com/YOUR_USERNAME_HERE/heads-wiki/wiki`).
tlaurion
added a commit
that referenced
this pull request
Sep 1, 2026
tlaurion
force-pushed
the
fix/pages-steps-234
branch
from
September 1, 2026 01:52
c592094 to
1f23b8d
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
Development/Contributing-to-Heads-Wiki.md:111
- The Wiki URL example hard-codes
heads-wiki, but earlier steps correctly generalize that a fork may have a different repository name. If the fork repo name differs, this Wiki link will be wrong/misleading; it should useYOUR_FORK_REPO_NAMEas well.
> **Note:** The URL above is your fork's **GitHub Pages** site. It is not the
> same as the built-in **Wiki** tab on your GitHub repo
> (`https://github.com/YOUR_USERNAME_HERE/heads-wiki/wiki`).
tlaurion
added a commit
that referenced
this pull request
Sep 1, 2026
tlaurion
added a commit
that referenced
this pull request
Sep 1, 2026
Fixes #234 Rewrite the 'Testing Changes on GitHub' section of the contributing guide into clear numbered steps using the current GitHub interface (Settings > Pages > Deploy from a branch, folder '/ (root)'). - Generalize the published URL to the fork's repository name (a fork named heads-wiki-x280 publishes at /heads-wiki-x280/, not always /heads-wiki/). - Note that a green Pages build does not mean the change is live yet; Pages can lag a few minutes after a build and there is no manual refresh. - Incorporate the top-level CNAME / custom-domain behavior: when enabling Pages on a fork, clear the 'Custom domain' field in the fork's Pages settings (do not delete or rename the tracked CNAME file). - Also fix github->GitHub casing, the '** NOTE:**' spacing, and 'prior of'->'prior to'.
tlaurion
force-pushed
the
fix/pages-steps-234
branch
from
September 1, 2026 03:51
5e59593 to
93d5ad8
Compare
tlaurion
added a commit
that referenced
this pull request
Sep 1, 2026
Address Copilot readability feedback: split the CNAME paragraph run-on, and reword 'before pushing your changes' to 'before opening your pull request'.
tlaurion
added a commit
that referenced
this pull request
Sep 1, 2026
Clarify that GitHub sets the tracked CNAME as the fork's Pages Custom domain and then fails DNS verification (because the fork owner does not control osresearch.net), rather than 'associating' the fork with the custom domain. Addresses Copilot feedback on the mechanism.
tlaurion
added a commit
that referenced
this pull request
Sep 1, 2026
Address Copilot feedback: clearing the Custom domain field is a fork Pages setting and can itself write/remove the CNAME file on the Pages source branch. Clarify that contributors should not manually delete/rename the tracked CNAME in their PR branch, and note the caveat when the PR branch doubles as the Pages source.
tlaurion
added a commit
that referenced
this pull request
Sep 1, 2026
…r forks (#240) Reworks the 'Testing Changes on GitHub' section in Contributing-to-Heads-Wiki: numbered GitHub Pages publishing steps for a fork, YOUR_FORK_REPO_NAME URL, green-build lag note, and an accurate CNAME/custom-domain paragraph. Clearing the Pages Custom domain field is a fork Pages setting (GitHub may write/remove the CNAME file on the Pages source branch; do not manually delete the tracked CNAME). Adds a Wiki-tab note and fixes GitHub capitalization/spacing consistency. Fixes #234 Fixes #235
tlaurion
force-pushed
the
fix/pages-steps-234
branch
from
September 1, 2026 04:30
9c5f10c to
ccdfbeb
Compare
…r forks (#240) Reworks the 'Testing Changes on GitHub' section in Contributing-to-Heads-Wiki: numbered GitHub Pages publishing steps for a fork, YOUR_FORK_REPO_NAME URL, green-build lag note, and an accurate CNAME/custom-domain paragraph. Clearing the Pages Custom domain field is a fork Pages setting (GitHub may write/remove the CNAME file on the Pages source branch; do not manually delete the tracked CNAME). Adds a Wiki-tab note and fixes GitHub capitalization/spacing consistency. Fixes #234 Fixes #235
tlaurion
force-pushed
the
fix/pages-steps-234
branch
from
September 1, 2026 04:39
ccdfbeb to
bf21cde
Compare
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.
Fixes #234
Fixes #235
Rewrites the prose paragraph about enabling GitHub Pages on a fork into clear numbered steps using the current GitHub interface (Settings > Pages > Deploy from a branch, folder "/ (root)"). Incorporates real contributor feedback (see #227):
heads-wiki-x280publishes at/heads-wiki-x280/, not always/heads-wiki/).This addresses the confusing/broken GitHub Pages instructions on the contributing page.