docs: fix two broken links in README (license badge, docs reference) - #1068
Merged
Conversation
The MIT License badge pointed at `/tree/main/LICENSE`, but the only license file in the repository is `LICENSE.md`, so the badge linked to a 404. Point it at `/blob/main/LICENSE.md`. The `[docs]` link reference (used by "Please see our [documentation][docs]") carried a trailing slash. The website sets `trailingSlash: false` in website/docusaurus.config.js, so `/docs/` serves the Docusaurus 404 route while `/docs` serves the page. It was also the only trailing-slash visgl.github.io URL in the README; every sibling reference definition already omits it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Collaborator
|
Thanks a lot! I can still access pages with and without a trailing slash, so not sure what you've been seeing, but removing the slash is consistent with other urls, so... Also: please don't waste your tokens on something like that :D |
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.
Two links in the root
README.mdcurrently return hard 404s. This PR fixes both; the diff is two lines and touches nothing else.1. MIT License badge (line 3)
The badge links to
/tree/main/LICENSE, but the repository's only license file isLICENSE.md— there is no path namedLICENSE, so the badge 404s.This is a missing file, not a
/tree/vs/blob/quirk — GitHub happily resolves tree paths for files that exist:2.
[docs]link reference (line 263)This is the target of "Please see our [documentation][docs]" on line 66. It carries a trailing slash that the site does not serve.
The root cause is the site's own deliberate configuration —
website/docusaurus.config.js:18setstrailingSlash: false, so the build emits no/docs/index.htmland the trailing-slash form falls through to the Docusaurus 404 route:Line 263 was also the only trailing-slash
visgl.github.ioURL in the whole README (grep -cE '.../[^ ]*/$' README.md→1); the ten[api-*]definitions above it and[examples]below it already omit it and all resolve.Verification
Status codes before → after, run against the live site:
The two 200s are real pages, not soft-404s — see the
<title>check above. Both replacement URLs were re-extracted from the editedREADME.mdand curled again to confirm they are exactly what the file now contains.Checklist notes
test:prettierchecks./src ./examplesandtest:lintercheckssrc/**, so a root-README.md-only change is outside the suite's scope entirely;test:tscandtest:unitare likewise unaffected. Happy to run the full suite if you'd like it on the record.docs/api-reference,upgrade-guide.mdorwhats-new.mdchanges are needed.Limitation
For defect 2 you could alternatively make the site serve
/docs/, but sincetrailingSlash: falseis an intentional setting, the README is the aligned side to change. I deliberately did not renameLICENSE.md, which would be a larger unrequested change.🤖 Generated with Claude Code