This repository has been archived by the owner on Jul 20, 2020. It is now read-only.
Fixing (hopefully) all three.js documentation links #177
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.
Addresses issue #175
Here's how this was done:
First I extracted all links using Ack and Vim, and removed duplicates using
:sort u
in Vim.Through sheer luck I found all three.js doc pages load https://threejs.org/docs/list.js, which lists all relative doc paths, excluding method links.
Then I wrote a node script to compare all links found in the R3R project to the links from the above mentioned
list.js
. That script is found hereIf you run this script with
node test-r3r-links.js
, it will not error. The assert on the last line is what verifies all links in R3R source exist in three.js's list.js index.NOTE: I DID NOT HAND VERIFY THE METHOD SPECIFIC LINKS. As in, I know https://threejs.org/docs/#api/extras/core/Path is correct, but I did not hand verify all the method links like https://threejs.org/docs/#api/extras/core/Path.absarc
The actual change to the codebase took several search and replace sweeps in Visual Studio Code. It was made easier by the fact that the original doc links in R3R link to http, while the updated three docs all redirect to https.
Fun facts:
/materials/
vs/Materials/