docs: fix all 158 broken links #5972
Merged
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.
Right now (2025-03-21T00:14:25+0900) there are a lot of broken links in the TanStack Table documentation. This PR should fix every single one of them.
Should obsolete #5965, #5934, #5918 and fix #5947 if merged.
How
I listed the broken links on my end like this:
Notes
There is some magic with relative links: "../" seems to navigate to "../../" instead (???), while ./ is the current path. As a result every replacement here is manually done and tested with lychee. Exceptional cases are explained in the details section below.
I haven't checked whether this is an issue with just TanStack Table docs, or if it's a thing that should be fixed in tanstack.com. I still decided to make this fix (and this PR) because there has already been prior PRs that adapt links to this form.
When checking the result afterwards, there may be one broken link left if locally only the /tanstack/tanstack.com and /tanstack/table repositories are checked out:
from localhost:3000/table/latest/docs/guide/virtualization, linking to localhost:3000/virtual/v3/docs/api/virtualizer. This is an artifact of the way it's checked out, and the link target actually exists if the TanStack Virtual docs are present.
Detailed changes
docs/api/core/{cell,column,header-group,header,row,table}:
The link to /docs/guide/features currently link to /guide/features
instead, and causes a redirect loop.
This error is deployed right now: check eg.
https://tanstack.com/table/latest/docs/api/core/cell
and click the "table features" link.
(This is not exceptional, just the first case I tackled.)
docs/guide/headers:
Aside from fixing paths, also fix an incorrect reference to
non-existant Column Resizing Guide at docs/guide/column-resizing;
presumably this is misspelling for the Column Sizing Guide at
docs/guide/column-sizing.
docs/guide/row-selection
Beyond fixing paths, also fix a missing /example/ in the vue example
path.