Skip to content

Commit f7bf6f1

Browse files
authored
docs: fix all 158 broken links (#5972)
Would obsolete #5965, #5918 if merged. I listed the broken links on my end like this: # utilizing lychee # lychee doesn't support checking links recursively from a web page; # but we do have a kind of sitemap here that we can pass to it. cd tanstack-table/docs/ lychee $(find . -name '*.md' | sed 's~./~https://tanstack.com/table/latest/docs/~;s/.md//') # for the local build; might also want `--timeout 60` lychee $(find . -name '*.md' | sed 's~./~http://localhost:3000/table/latest/docs/~;s/.md//') # sed's separator in 's/from/to/' can be changed to avoid escaping, # so 's~from~to~' has the same effect except slashes can stay as-is. # then s/.md// gets rid of the extension, completing the conversion # to deployed URLs. # (I'm explaining all this because I'm also scared by the xz takeover.) 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. 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. Detailed changes: docs/api/core/{cell,column,header-group,header,row,table}: 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.
1 parent 3efa59c commit f7bf6f1

39 files changed

+169
-169
lines changed

docs/api/core/cell.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Cell APIs
33
---
44

5-
These are **core** options and API properties for all cells. More options and API properties are available for other [table features](../../../guide/features).
5+
These are **core** options and API properties for all cells. More options and API properties are available for other [table features](../guide/features).
66

77
## Cell API
88

docs/api/core/column.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Column APIs
33
---
44

5-
These are **core** options and API properties for all columns. More options and API properties are available for other [table features](../../../guide/features).
5+
These are **core** options and API properties for all columns. More options and API properties are available for other [table features](../guide/features).
66

77
## Column API
88

docs/api/core/header-group.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: HeaderGroup APIs
33
---
44

5-
These are **core** options and API properties for all header groups. More options and API properties may be available for other [table features](../../../guide/features).
5+
These are **core** options and API properties for all header groups. More options and API properties may be available for other [table features](../guide/features).
66

77
## Header Group API
88

@@ -30,4 +30,4 @@ The depth of the header group, zero-indexed based.
3030
type headers = Header<TData>[]
3131
```
3232
33-
An array of [Header](../header) objects that belong to this header group
33+
An array of [Header](../api/core/header) objects that belong to this header group

docs/api/core/header.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Header APIs
33
---
44

5-
These are **core** options and API properties for all headers. More options and API properties may be available for other [table features](../../../guide/features).
5+
These are **core** options and API properties for all headers. More options and API properties may be available for other [table features](../guide/features).
66

77
## Header API
88

@@ -38,15 +38,15 @@ The depth of the header, zero-indexed based.
3838
column: Column<TData>
3939
```
4040

41-
The header's associated [Column](../column) object
41+
The header's associated [Column](../api/core/column) object
4242

4343
### `headerGroup`
4444

4545
```tsx
4646
headerGroup: HeaderGroup<TData>
4747
```
4848

49-
The header's associated [HeaderGroup](../header-group) object
49+
The header's associated [HeaderGroup](../api/core/header-group) object
5050

5151
### `subHeaders`
5252

docs/api/core/row.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Row APIs
33
---
44

5-
These are **core** options and API properties for all rows. More options and API properties are available for other [table features](../../../guide/features).
5+
These are **core** options and API properties for all rows. More options and API properties are available for other [table features](../guide/features).
66

77
## Row API
88

@@ -120,4 +120,4 @@ An array of the original subRows as returned by the `options.getSubRows` option.
120120
type getAllCells = () => Cell<TData>[]
121121
```
122122
123-
Returns all of the [Cells](../cell) for the row.
123+
Returns all of the [Cells](../api/core/cell) for the row.

docs/api/core/table.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ These functions are used to create a table. Which one you use depends on which f
1414
1515
## Options
1616
17-
These are **core** options and API properties for the table. More options and API properties are available for other [table features](../../../guide/features).
17+
These are **core** options and API properties for the table. More options and API properties are available for other [table features](../guide/features).
1818
1919
### `data`
2020
@@ -89,7 +89,7 @@ declare module '@tanstack/table-core' {
8989
}
9090
```
9191

92-
> 🧠 Think of this option as an arbitrary "context" for your table. This is a great way to pass arbitrary data or functions to your table without having to pass it to every thing the table touches. A good example is passing a locale object to your table to use for formatting dates, numbers, etc or even a function that can be used to update editable data like in the [editable-data example](../../../framework/react/examples/editable-data).
92+
> 🧠 Think of this option as an arbitrary "context" for your table. This is a great way to pass arbitrary data or functions to your table without having to pass it to every thing the table touches. A good example is passing a locale object to your table to use for formatting dates, numbers, etc or even a function that can be used to update editable data like in the [editable-data example](../framework/react/examples/editable-data).
9393
9494
### `state`
9595

docs/api/features/filters.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ id: filters
77

88
The Filtering API docs are now split into multiple API doc pages:
99

10-
- [Column Faceting](../column-faceting)
11-
- [Global Faceting](../global-faceting)
12-
- [Column Filtering](../column-filtering)
13-
- [Global Filtering](../global-filtering)
10+
- [Column Faceting](../api/features/column-faceting)
11+
- [Global Faceting](../api/features/global-faceting)
12+
- [Column Filtering](../api/features/column-filtering)
13+
- [Global Filtering](../api/features/global-filtering)

docs/api/features/global-filtering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export interface GlobalFilterTableState {
2525

2626
## Filter Functions
2727

28-
You can use the same filter functions that are available for column filtering for global filtering. See the [Column Filtering APIs](../column-filtering) to learn more about filter functions.
28+
You can use the same filter functions that are available for column filtering for global filtering. See the [Column Filtering APIs](../api/features/column-filtering) to learn more about filter functions.
2929

3030
#### Using Filter Functions
3131

docs/api/features/pinning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ id: pinning
77

88
The pinning apis are now split into multiple api pages:
99

10-
- [Column Pinning](../column-pinning)
11-
- [Row Pinning](../row-pinning)
10+
- [Column Pinning](../api/features/column-pinning)
11+
- [Row Pinning](../api/features/row-pinning)

docs/api/features/row-selection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export type RowSelectionTableState = {
1515
}
1616
```
1717
18-
By default, the row selection state uses the index of each row as the row identifiers. Row selection state can instead be tracked with a custom unique row id by passing in a custom [getRowId](../../../api/core/table.md#getrowid) function to the the table.
18+
By default, the row selection state uses the index of each row as the row identifiers. Row selection state can instead be tracked with a custom unique row id by passing in a custom [getRowId](../core/table.md#getrowid) function to the the table.
1919
2020
## Table Options
2121

0 commit comments

Comments
 (0)