Skip to content

Fix broken default "Edit this page" URL - #35

Open
SafraNako wants to merge 1 commit into
theQRL:mainfrom
SafraNako:fix/broken-edit-this-page-url
Open

SafraNako wants to merge 1 commit into
theQRL:mainfrom
SafraNako:fix/broken-edit-this-page-url

Conversation

@SafraNako

Copy link
Copy Markdown

Problem

docusaurus.config.js sets the docs plugin's default editUrl to:

editUrl: 'https://github.com/theqrl.org/documentation',

That treats the docs site's custom domain (theqrl.org) as if it were a
GitHub org/user name, giving github.com/theqrl.org/documentation
which 404s:

$ curl -o /dev/null -w '%{http_code}\n' https://github.com/theqrl.org/documentation
404

Fix

The GitHub org is theQRL (github.com/theQRL/documentation), and
Docusaurus's editUrl convention for the docs plugin is the folder
containing docs/ with /edit/<branch>/ appended — it appends each
page's own relative path under docs/ automatically:

editUrl: 'https://github.com/theQRL/documentation/edit/main/',
$ curl -o /dev/null -w '%{http_code}\n' \
    https://github.com/theQRL/documentation/edit/main/docs/getting-started.md
302   # redirects to GitHub login, i.e. the route exists

Scope

Almost every page in docs/ already sets its own custom_edit_url in
frontmatter, which overrides this default — so today only one page
(docs/Use/Tools/ems/_emsInfo.md, a partial) is directly affected. But
it's the default every future page inherits unless a contributor
remembers to add the override, so it's worth having correct.

Verification

npm run build (the site has onBrokenLinks: 'throw') completes clean:

✔ Client: Compiled successfully
✔ Server: Compiled successfully
[SUCCESS] Generated static files in "build".

🤖 Generated with Claude Code

docusaurus.config.js set the docs plugin's editUrl to
`https://github.com/theqrl.org/documentation`, treating the docs site's
custom domain (theqrl.org) as if it were the GitHub org name. That path
404s.

The correct GitHub org is theQRL (github.com/theQRL/documentation), and
Docusaurus's editUrl convention is the folder *containing* docs/, with
/edit/<branch>/ appended — Docusaurus appends the file's own relative
path under docs/ automatically.

Only one page in the current docs set (docs/Use/Tools/ems/_emsInfo.md, a
partial) lacks its own custom_edit_url override, so today's practical
impact is limited to that page — but it's also the default every future
page inherits unless a contributor remembers to add one.

Verified: `npm run build` (onBrokenLinks: 'throw') completes clean, and
https://github.com/theQRL/documentation/edit/main/docs/getting-started.md
resolves (302 to GitHub login) where the previous URL 404s.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@netlify

netlify Bot commented Sep 11, 2026

Copy link
Copy Markdown

Deploy Preview for stalwart-palmier-0ab66c ready!

Name Link
🔨 Latest commit 0784d68
🔍 Latest deploy log https://app.netlify.com/projects/stalwart-palmier-0ab66c/deploys/6aa3ef3412eea1000900ed57
😎 Deploy Preview https://deploy-preview-35--stalwart-palmier-0ab66c.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant