docs: correct local relative links #6132
Conversation
|
WalkthroughThis PR reorganizes documentation directory structure by updating relative paths across 40+ markdown files and refactors the link verification script. Changes systematically adjust documentation links from paths like Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
|
View your CI Pipeline Execution ↗ for commit 129ff13
☁️ Nx Cloud last updated this comment at |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (6)
docs/guide/data.md (1)
248-248: Minor style improvement suggestion (optional).Line 248 uses "a lot of" which could be more concise. Consider: "However, many developers underestimate just how much data can be handled client-side."
This is a low-priority stylistic refinement flagged by static analysis.
docs/guide/pagination.md (1)
33-33: Minor style improvement suggestion (optional).Line 33 uses "a lot of people" which could be more concise. Consider: "However, many developers underestimate just how much data can be handled client-side."
Flagged by static analysis as a stylistic refinement opportunity.
docs/api/core/row.md (1)
123-123: Minor style improvement suggestion (optional).Line 123 uses "all of the [Cells]" which could be more concise. Consider: "Returns all Cells for the row."
Flagged by static analysis as a stylistic refinement opportunity.
docs/guide/columns.md (1)
11-11: Consider using./for same-directory references.The
../guide/pattern works but is redundant since this file is already indocs/guide/. For example,../guide/column-defscould be simplified to./column-defs. However, this is a minor stylistic preference and the current paths resolve correctly.Also applies to: 21-21, 50-50, 70-70
docs/guide/row-pinning.md (1)
20-20: Minor: Consider using same-directory reference for sibling guide.Line 20 uses
../guide/sortingwhich works, but since both files are indocs/guide/, using./sorting.mdwould be more direct and idiomatic. This is a nitpick and doesn't affect functionality.docs/guide/header-groups.md (1)
28-28: Minor style suggestion: consider "among" instead of "amongst".Line 28 uses "amongst", which is less common in modern usage compared to "among". This is entirely optional and a matter of style preference.
- - `depth`: The depth of the header group, zero-indexed based. Think of this as the row index amongst all header rows. + - `depth`: The depth of the header group, zero-indexed based. Think of this as the row index among all header rows.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (40)
docs/api/core/cell.md(1 hunks)docs/api/core/column.md(1 hunks)docs/api/core/header-group.md(2 hunks)docs/api/core/header.md(2 hunks)docs/api/core/row.md(2 hunks)docs/api/core/table.md(2 hunks)docs/api/features/filters.md(1 hunks)docs/api/features/global-filtering.md(1 hunks)docs/api/features/pinning.md(1 hunks)docs/api/features/row-selection.md(1 hunks)docs/framework/react/guide/table-state.md(1 hunks)docs/guide/cells.md(2 hunks)docs/guide/column-defs.md(2 hunks)docs/guide/column-faceting.md(1 hunks)docs/guide/column-filtering.md(2 hunks)docs/guide/column-ordering.md(3 hunks)docs/guide/column-pinning.md(3 hunks)docs/guide/column-sizing.md(2 hunks)docs/guide/column-visibility.md(1 hunks)docs/guide/columns.md(4 hunks)docs/guide/custom-features.md(2 hunks)docs/guide/data.md(3 hunks)docs/guide/expanding.md(2 hunks)docs/guide/features.md(1 hunks)docs/guide/filters.md(1 hunks)docs/guide/fuzzy-filtering.md(1 hunks)docs/guide/global-faceting.md(1 hunks)docs/guide/global-filtering.md(3 hunks)docs/guide/grouping.md(1 hunks)docs/guide/header-groups.md(1 hunks)docs/guide/headers.md(4 hunks)docs/guide/pagination.md(2 hunks)docs/guide/pinning.md(1 hunks)docs/guide/row-pinning.md(1 hunks)docs/guide/row-selection.md(1 hunks)docs/guide/rows.md(3 hunks)docs/guide/sorting.md(1 hunks)docs/guide/tables.md(3 hunks)docs/overview.md(2 hunks)scripts/verify-links.ts(5 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-09-15T15:05:14.117Z
Learnt from: stevenwjy
Repo: TanStack/table PR: 6094
File: packages/table-core/src/utils/getGroupedRowModel.ts:74-78
Timestamp: 2025-09-15T15:05:14.117Z
Learning: In TanStack Table's Row interface, the `subRows` property is typed as `Row<TData>[]` (not optional) and the `createRow` function always initializes it as an empty array, so `subRows` is guaranteed to never be undefined.
Applied to files:
docs/api/core/row.mddocs/api/core/table.mddocs/guide/data.mddocs/api/core/header.mddocs/guide/rows.mddocs/guide/tables.mddocs/overview.md
📚 Learning: 2025-09-15T15:05:14.117Z
Learnt from: stevenwjy
Repo: TanStack/table PR: 6094
File: packages/table-core/src/utils/getGroupedRowModel.ts:74-78
Timestamp: 2025-09-15T15:05:14.117Z
Learning: In TanStack Table's Row interface, the `subRows` property is typed as `Row<TData>[]` (not optional) and the `createRow` function always initializes it as an empty array using `subRows ?? []`, so `subRows` is guaranteed to never be undefined.
Applied to files:
docs/api/core/row.mddocs/api/core/table.mddocs/guide/data.mddocs/guide/rows.mddocs/guide/tables.mddocs/overview.md
🪛 LanguageTool
docs/api/core/row.md
[style] ~123-~123: Consider removing “of” to be more concise
Context: ...ells = () => Cell[] ``` Returns all of the Cells for the row.
(ALL_OF_THE)
docs/guide/data.md
[style] ~248-~248: Consider using a synonym to be more concise.
Context: ... This is still usually a good idea, but a lot of developers underestimate how much data ...
(A_LOT_OF)
docs/guide/tables.md
[grammar] ~74-~74: Ensure spelling is correct
Context: ...the same TData type that you used for you data. ```ts const columns: ColumnDef<U...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[style] ~129-~129: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...hat are generated may be very different than the array of data that you originally...
(DIFFERENT_THAN)
docs/guide/header-groups.md
[style] ~28-~28: The preposition ‘amongst’ is correct, but some people think that it is old-fashioned or literary. A more frequently used alternative is the preposition “among”.
Context: ...d based. Think of this as the row index amongst all header rows. - headers: An array ...
(AMONGST)
docs/guide/column-ordering.md
[grammar] ~107-~107: Use a hyphen to join words.
Context: ...s a modern, modular and lightweight drag and drop library that is highly compatib...
(QB_NEW_EN_HYPHEN)
[grammar] ~107-~107: Use a hyphen to join words.
Context: ...modern, modular and lightweight drag and drop library that is highly compatible w...
(QB_NEW_EN_HYPHEN)
docs/guide/global-filtering.md
[style] ~25-~25: Consider using a synonym to be more concise.
Context: ...should-you-use-client-side-pagination), a lot of developers underestimate how many rows ...
(A_LOT_OF)
docs/guide/column-filtering.md
[style] ~32-~32: Consider using a synonym to be more concise.
Context: ...should-you-use-client-side-pagination), a lot of developers underestimate how many rows ...
(A_LOT_OF)
docs/guide/pagination.md
[style] ~33-~33: Consider using a synonym to be more concise.
Context: ...ical for very large datasets. However, a lot of people underestimate just how much data...
(A_LOT_OF)
🪛 markdownlint-cli2 (0.18.1)
docs/guide/column-pinning.md
12-12: Headings must start at the beginning of the line
(MD023, heading-start-left)
🔇 Additional comments (43)
docs/api/core/column.md (1)
5-5: ✓ Link path correction is accurate.The relative path adjustment from
../../../guide/features.mdto../../guide/features.mdcorrectly reflects the directory hierarchy. Fromdocs/api/core/, going up two levels reachesdocs/, enabling correct resolution todocs/guide/features.md.docs/api/core/cell.md (1)
5-5: ✓ Link path correction matches the pattern in related files.The relative path adjustment is consistent with other API core documentation updates and correctly resolves to
docs/guide/features.md.docs/framework/react/guide/table-state.md (1)
9-10: ✓ Link paths correctly adjusted for framework-specific examples.The change from
../../examples/to../examples/properly reflects the relative depth fromdocs/framework/react/guide/todocs/framework/react/examples/.docs/api/features/row-selection.md (1)
18-18: ✓ Link path correctly simplified for same-namespace reference.The change from
../../core/table.mdto../core/table.mdcorrectly resolves within thedocs/api/namespace.docs/guide/row-selection.md (1)
15-15: ✓ Cross-namespace link path corrected.The change from
../../api/features/row-selection.mdto../api/features/row-selection.mdcorrectly navigates fromdocs/guide/up todocs/and then into the API documentation.docs/guide/column-sizing.md (1)
9-10: ✓ All relative paths consistently corrected across multiple link types.The systematic updates from
../../to../properly reflect the navigation fromdocs/guide/to examples and API reference documentation at thedocs/level. Examples links to../framework/react/examples/, API link to../api/features/, and advanced example link are all correctly resolved.Also applies to: 14-14, 169-169
docs/api/features/global-filtering.md (1)
28-28: ✓ Link path correctly adjusted for guide reference.The change from
../../../guide/column-filtering.mdto../../guide/column-filtering.mdproperly resolves from the API features documentation to the guides section.docs/guide/global-filtering.md (2)
13-13: ✓ Cross-namespace and same-namespace link paths correctly updated.The changes from
../../to../properly reflect navigation fromdocs/guide/to both API references and pagination guide within the documentation structure.Also applies to: 25-25
141-141: Verify that fuzzy-filtering.md exists at the target location.Line 141 uses
./fuzzy-filtering.md, which assumes a filefuzzy-filtering.mdexists in the same directory (docs/guide/). Confirm this file exists and the link target is valid.docs/guide/custom-features.md (1)
9-9: Consistent relative path updates applied.Both references to the custom-features example have been systematically updated from
../../to../, aligning with the PR's documentation structure correction. The changes are consistent and syntactically correct.Please verify that the new relative paths now correctly resolve to the intended targets. Given the systematic nature of these changes across 40+ files, confirming that
../framework/react/examples/custom-featuresresolves correctly fromdocs/guide/custom-features.mdwould validate the entire PR refactor.Also applies to: 111-111
docs/guide/sorting.md (1)
9-10: Consistent link corrections across multiple reference types.Updates apply consistently across example links (lines 9–10) and API documentation reference (line 14), all following the
../../→../pattern. The corrections maintain internal consistency.Also applies to: 14-14
docs/guide/data.md (1)
136-136: Internal guide-to-guide links consistently updated.All four cross-references to other guides within
docs/guide/have been systematically updated from../../guide/...to../guide/..., including preservation of the anchor fragment on line 250. The pattern is consistently applied.Also applies to: 182-182, 242-242, 250-250
docs/guide/column-faceting.md (1)
9-9: Relative path corrections applied consistently.Both the example reference and API documentation link have been updated from
../../to../, following the established refactoring pattern.Also applies to: 13-13
docs/api/features/filters.md (1)
10-13: Guide reference links consistently updated from API features directory.All four guide cross-references have been updated from
../../../guide/...to../../guide/..., reflecting the correct relative navigation fromdocs/api/features/todocs/guide/. Updates are uniform across all four linked guides.docs/guide/pagination.md (1)
9-15: Comprehensive relative path updates applied systematically.All example links (lines 9–15), the API reference (line 19), and the inline example reference (line 33) have been updated from
../../to../consistently. The refactoring is thorough across multiple link types and contexts.Also applies to: 19-19, 33-33
docs/guide/features.md (1)
7-20: Navigation index correctly updated to use same-directory references.All 14 feature guide links have been updated from
../Xto./X, which is the appropriate pattern for same-directory references. This is correct for a navigation index page withindocs/guide/.docs/api/core/row.md (1)
5-5: Relative path updates correct for different navigation contexts.Line 5 appropriately updates the features guide cross-reference from
../../../to../../, and line 123 correctly updates the same-directory cell reference to./. Both changes are contextually appropriate.Also applies to: 123-123
docs/overview.md (1)
13-13: LGTM! Relative links updated correctly.The link paths are updated to resolve locally from the
docs/directory:
./introduction.md→docs/introduction.md./guide/features.md→docs/guide/features.mdAlso applies to: 36-36
docs/api/core/header.md (1)
5-5: LGTM! Link paths correctly adjusted.The relative paths resolve appropriately:
../../guide/features.mdcorrectly navigates fromdocs/api/core/todocs/guide/features.md./column.mdand./header-group.mdcorrectly reference sibling files in the same directoryAlso applies to: 41-41, 49-49
docs/guide/columns.md (1)
7-7: LGTM! Link path correctly adjusted.docs/guide/global-faceting.md (1)
9-9: LGTM! Link paths correctly adjusted.Both relative paths resolve correctly from
docs/guide/to their target locations.Also applies to: 13-13
docs/guide/cells.md (1)
7-7: LGTM! Link paths correctly adjusted.The relative paths resolve correctly. Same note applies as in
columns.mdregarding the../guide/pattern for same-directory references.Also applies to: 15-15, 35-35
docs/guide/column-visibility.md (1)
9-16: LGTM! Link paths correctly adjusted.All example and API links resolve correctly from
docs/guide/to their target locations.Also applies to: 20-20
scripts/verify-links.ts (5)
14-23: LGTM! Exclusion patterns are appropriate.The function correctly filters out absolute paths, URLs, fragment-only links, and mailto links.
25-28: LGTM! Extension stripping logic is correct.Using
extnamecorrectly handles various edge cases including files without extensions and filenames with multiple dots.
30-86: Core validation logic looks correct.The resolution approach correctly simulates web-relative navigation by:
- Stripping extensions from both the source file and the link target
- Resolving from the parent directory of the source file
- Re-adding
.mdfor non-example pathsOne consideration: if documentation ever links to non-
.mdfiles (other than examples), those would fail validation since lines 71-73 unconditionally append.md. This seems acceptable given the current docs structure, but worth noting if the docs expand to include other file types.
88-125: LGTM! Main verification flow is well-structured.The function correctly:
- Globs all markdown files
- Extracts and filters relative links
- Validates each link and accumulates errors
- Exits with code 1 when broken links are found
7-12: LGTM! Error accumulation approach is appropriate for CLI script.The global errors array simplifies the control flow for this single-run verification script.
docs/guide/filters.md (1)
9-12: Link paths correctly adjusted for same-directory references.The filter guide links now use
./prefix for sibling guides within the same directory, which is a clearer and more maintainable approach than the previous../../paths.docs/api/core/table.md (1)
17-17: Link paths correctly adjusted for cross-section references.The links from API docs to guide sections properly reflect the reduced depth (from
../../../guide/to../../guide/), accounting for the flatter hierarchy.Also applies to: 37-37
docs/guide/fuzzy-filtering.md (1)
9-9: Link paths correctly adjusted for external top-level directory navigation.Both links properly reflect the reduction from two levels to one level when accessing
framework/andapi/directories from guide docs.Also applies to: 13-13
docs/guide/pinning.md (1)
9-10: Link paths correctly adjusted for same-directory references.Both links to sibling guides properly use
./prefix, which is the idiomatic approach for same-directory references.docs/api/core/header-group.md (1)
5-5: Link paths correctly adjusted; same-directory reference improved.Line 5 properly reflects the reduced depth for guide references (
../../guide/). Line 32's change from../header.mdto./header.mdis an improvement, making the same-directory reference more explicit and direct.Also applies to: 32-32
docs/api/features/pinning.md (1)
10-11: Link paths correctly adjusted for cross-section references.Both links properly reduce the path depth from three levels to two (
../../../guide/→../../guide/), reflecting the restructured hierarchy.docs/guide/grouping.md (1)
13-13: Link paths correctly adjusted; same-directory references improved.Line 13 properly reduces the cross-section reference depth (
../../api/→../api/). Lines 19–20's changes from../column-pinning.mdand../column-ordering.mdto./references are improvements for same-directory navigation.Also applies to: 19-20
docs/guide/column-filtering.md (1)
18-18: Link paths updated to reflect new directory structure.The relative path adjustments from
../../api/...to../api/...and local guide references are correct and align with the PR's objective to adjust link validation to the current directory level.Also applies to: 32-32
docs/guide/column-ordering.md (1)
9-10: Link paths consistently updated to match flattened directory structure.All relative paths have been systematically adjusted from
../../to../for API and framework references, and cross-guide links have been updated accordingly. Changes align with the PR's objective.Also applies to: 14-14, 24-24, 26-26, 107-107
docs/guide/rows.md (1)
7-7: Internal guide links updated to reflect directory restructuring.Relative paths adjusted from
../../to../for API and guide cross-references. Changes maintain logical grouping and are consistent with the PR's scope.Also applies to: 27-27, 88-88
docs/guide/column-pinning.md (1)
9-10: Consistent relative path updates for all internal references.Framework example paths, API references, and cross-guide links have been systematically updated from
../../to../. Anchor links in API references are properly formatted.Also applies to: 14-15, 19-19, 24-24, 31-31, 80-87
docs/guide/expanding.md (1)
9-11: API and framework paths updated; same-directory guide link adjusted to./notation.Example references now point to
../framework/react/examples/...and API to../api/features/expanding. Line 214 correctly uses./pinning.mdfor a same-directory reference, confirming the flattened docs hierarchy.Also applies to: 15-15, 214-214
docs/guide/tables.md (1)
7-7: API links updated; same-directory guide references converted to./notation.API paths now use
../api/core/...and same-directory guide links use./for column-defs and row-models, confirming the directory restructuring.Also applies to: 74-74, 82-82, 125-125, 129-129
docs/guide/headers.md (1)
7-7: All relative paths systematically updated from../../to../for API, guide, and framework references.Changes maintain proper directory navigation and are consistent across all link types.
Also applies to: 17-17, 45-45, 49-49, 68-68, 72-72
docs/guide/column-defs.md (1)
7-7: API paths updated to../api/core/...; same-directory grouping reference uses./notation.All link adjustments are consistent with the flattened directory structure and PR objectives.
Also applies to: 15-15, 245-245
| ## API | ||
|
|
||
| [Header Group API](../../api/core/header-group) | ||
| [Header Group API](../api/core/header-group) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# First, let's check the actual content of the file and verify the structure
git ls-files docs/guide/header-groups.mdRepository: TanStack/table
Length of output: 85
🏁 Script executed:
# Check the actual lines mentioned in the review
cat -n docs/guide/header-groups.md | head -35Repository: TanStack/table
Length of output: 2091
🏁 Script executed:
# Now verify that all the target documentation files exist
# Based on the claimed paths in the review
for link in "docs/api/core/header-group.md" "docs/framework/react/examples/column-groups.md" "docs/guide/rows.md" "docs/guide/headers.md"; do
if [ -f "$link" ]; then
echo "✓ Found: $link"
else
echo "✗ Missing: $link"
# Try to find similar files
echo " Searching for similar files..."
fd -i "$(basename "$link" .md)" docs/ 2>/dev/null | head -5
fi
doneRepository: TanStack/table
Length of output: 246
🏁 Script executed:
# Also check the docs directory structure
find docs -type f -name "*.md" | head -20Repository: TanStack/table
Length of output: 672
🏁 Script executed:
# Search for column-groups related files
find docs -type f -name "*column*group*" 2>/dev/nullRepository: TanStack/table
Length of output: 40
🏁 Script executed:
# Also check framework directory structure
find docs/framework -type d -name "*react*" 2>/dev/null | head -10Repository: TanStack/table
Length of output: 78
🏁 Script executed:
# List all files in framework directories
find docs/framework -type f -name "*.md" 2>/dev/null | grep -i column | head -10Repository: TanStack/table
Length of output: 40
Line 15 contains a broken link that should be corrected.
While the relative path changes on lines 7, 23, and 29 are correct and resolve to existing documentation files, line 15's link to ../framework/react/examples/column-groups points to a non-existent file. The directory docs/framework/react/examples/column-groups.md does not exist in the repository. This link needs to be either corrected to point to the actual location of the column groups example, or the referenced file needs to be created.
🤖 Prompt for AI Agents
In docs/guide/header-groups.md around line 15, the link
../framework/react/examples/column-groups points to a non-existent file; either
update that link to the correct existing path for the column groups example
(find the actual example file under docs/framework/react/... and replace the
relative path accordingly) or create the missing
docs/framework/react/examples/column-groups.md file with the intended content so
the link resolves.
🎯 Changes
Adjusts verify-links to ensure links can resolve locally (i.e. as intended), rather than having to resolve 1 level higher
The level adjusting is then handled by the TanStack website in #563
✅ Checklist
pnpm test:pr.🚀 Release Impact
Summary by CodeRabbit
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.