Skip to content

Fix typos and broken links in the docs - #174

Open
quassy wants to merge 4 commits into
RodrigoHamuy:mainfrom
quassy:docs/fix-typos-and-links
Open

quassy wants to merge 4 commits into
RodrigoHamuy:mainfrom
quassy:docs/fix-typos-and-links

Conversation

@quassy

@quassy quassy commented Nov 11, 2026 •

Copy link
Copy Markdown

Just wanted to fix the broken ThreeJS object example link, Claude found some other typos and broken/redirected links.


Fixes typos and broken links in README.md and stories/README.md, plus one typo in CHANGELOG.md. No code changes.

Broken links

  • MapLibre three.js example (maplibre.org/maplibre-gl-js-docs/example/add-3d-model/ returns 404). MapLibre renamed the example in 2025 and deleted it in October 2026 (maplibre-gl-js commit f98ef79). Its three.js examples now use the maplibre-gl-three helper library, so no page on maplibre.org still shows the low-level custom-layer code that the "how complex" sentence is about. The link now points to Mapbox's live Add a 3D model with three.js example, which builds the same kind of custom layer by hand. The original MapLibre page is still on the Wayback Machine (snapshot from 14 March 2023) if you'd rather link that.
  • Examples badge: the story canvas--a-maplibre-example no longer exists on the Ladle site. The badge now opens canvas--maplibre.
  • R3F docs: docs.pmnd.rs/react-three-fiber/… redirects to r3f.docs.pmnd.rs. The two links now point there directly; the #createroot anchor still exists.
  • Size badge: removed a stray ? from the badge's query string.

Typos and grammar

  • tone → ton, bellow → below, unnecesary → unnecessary, separated → separate canvas
  • Missing or wrong words: "how complex it is" (twice), "in exchange for", "it is not recommended", "which is an important factor", "the Increase latitude accuracy level #102 fix"
  • MapBox → Mapbox, Maplibre → MapLibre
  • The basic example imported useRef and useState twice, which doesn't compile
  • "main main" in stories/README.md, "coordiantes" in CHANGELOG.md

How it was checked

  • Requested every URL in the docs. Apart from the ones above, all of them work. npmjs.com and CodeSandbox block scripted requests: the package exists in the npm registry, but the CodeSandbox link was not checked.
  • Checked the story ids against the deployed Ladle site's meta.json.
  • Rendered the new README with GitHub's markdown API: every table of contents anchor resolves.

Not changed

Older changelog entries that state something wrong were left as release history:

  • In 0.8.2, the "Mapbox" link points to MapLibre's repository.
  • 0.2.0 says frameloop="ondemand", but the value is "demand".

🤖 Generated with Claude Code

- Link the MapLibre three.js example at its last version. MapLibre removed
  it and now only shows three.js through maplibre-gl-three, so the old URL
  is a 404 and no current page shows the raw custom layer code.
- Point the R3F docs links to r3f.docs.pmnd.rs, where docs.pmnd.rs redirects.
- Point the Examples badge to the existing canvas--maplibre story.
- Turn the two mentions of PR 102 into links; README files don't autolink them.
- Fix spelling and grammar (ton, below, unnecessary, separate, "how complex
  it is", MapLibre/Mapbox), a duplicate import in the basic example and a
  stray "?" in the size badge URL.
@quassy
quassy requested a review from RodrigoHamuy as a code owner November 11, 2026 17:12
@changeset-bot

changeset-bot Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: ebaac3f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

This branch has not been deployed

No deployments
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