Point the prose at Forgejo too, not just the URLs #1075

Merged
jaylouisw merged 1 commit from docs/forgejo-not-github into main 2026-11-08 15:17:08 +00:00
Owner

#1062 repointed every project URL at Forgejo, and test/canonical-urls.test.js keeps them pointed. Prose is what a URL checker cannot see: text that names GitHub as the place a bug is tracked or a wiki is published, with no URL in it for the check to match.

Four of those, each now wrong in a way that costs a contributor a wasted trip:

file said should say
test/known-issues.json entries are "tracked in GitHub" tracked in Forgejo — that file's whole purpose is to cite an issue
docs/REQUESTING-HARDWARE.md match an invariant "against a GitHub issue" against a Forgejo issue
scripts/build-wiki.js pages are "pushed to the GitHub wiki" Forgejo wiki
scripts/publish-wiki.js "A GitHub wiki is a separate git repository… GitHub creates the first" the instance creates it; REPO three lines below already points at git.jayw.uk

The last two are the interesting ones: the comment contradicted the constant directly beneath it, so anyone reading the file to understand where the wiki lives got the wrong answer from the prose and the right one from the code.

No behaviour changes — comments, one documentation sentence, and the _comment field of a JSON file that only humans read. test/known-issues.json still parses; scripts/syntax-check.js 162 files OK; hardware-invariants 22/22.

#1062 repointed every project URL at Forgejo, and `test/canonical-urls.test.js` keeps them pointed. Prose is what a URL checker cannot see: text that names GitHub as the place a bug is tracked or a wiki is published, with no URL in it for the check to match. Four of those, each now wrong in a way that costs a contributor a wasted trip: | file | said | should say | |---|---|---| | `test/known-issues.json` | entries are "tracked in GitHub" | tracked in Forgejo — that file's whole purpose is to cite an issue | | `docs/REQUESTING-HARDWARE.md` | match an invariant "against a GitHub issue" | against a Forgejo issue | | `scripts/build-wiki.js` | pages are "pushed to the GitHub wiki" | Forgejo wiki | | `scripts/publish-wiki.js` | "A GitHub wiki is a separate git repository… GitHub creates the first" | the instance creates it; `REPO` three lines below already points at `git.jayw.uk` | The last two are the interesting ones: the comment contradicted the constant directly beneath it, so anyone reading the file to understand where the wiki lives got the wrong answer from the prose and the right one from the code. No behaviour changes — comments, one documentation sentence, and the `_comment` field of a JSON file that only humans read. `test/known-issues.json` still parses; `scripts/syntax-check.js` 162 files OK; `hardware-invariants` 22/22.
Point the prose at Forgejo too, not just the URLs
Some checks failed
CI / Test (Node 18) (pull_request) Failing after 1m32s
CI / Test (Node 20) (pull_request) Failing after 1m27s
CI / Server smoke test (pull_request) Successful in 26s
CI / Docker build (pull_request) Successful in 10s
CI / Test (Node 22) (pull_request) Failing after 1m19s
cc48d56b8e
#1062 repointed every project URL, and test/canonical-urls.test.js keeps them
pointed. Prose is what it cannot see: text naming GitHub as the place a bug is
tracked or a wiki is published, with no URL in it for a checker to match.

Four of those, all now wrong in a way that costs a contributor a wasted trip:

- test/known-issues.json said entries are 'tracked in GitHub'. They are tracked in
  Forgejo, and that file's whole job is to cite an issue.
- docs/REQUESTING-HARDWARE.md told contributors to match an invariant against 'a
  GitHub issue'.
- scripts/build-wiki.js and scripts/publish-wiki.js describe publishing to the
  'GitHub wiki' while the code pushes to git.jayw.uk - the comment contradicts the
  constant three lines below it.

No behaviour changes: comments, one doc sentence, and the _comment field of a JSON
file that only humans read.
jaylouisw scheduled this pull request to auto merge when all checks succeed 2026-11-08 15:16:08 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jaylouisw/packetforge!1075
No description provided.