Skip to content

Fix nested TypeDoc index routes - #1160

Merged
tannerlinsley merged 2 commits into
mainfrom
agent/fix-nested-typedoc-index-routes
Aug 14, 2026
Merged

Fix nested TypeDoc index routes#1160
tannerlinsley merged 2 commits into
mainfrom
agent/fix-nested-typedoc-index-routes

Conversation

@KevinVandy

@KevinVandy KevinVandy commented Aug 14, 2026

Copy link
Copy Markdown
Member

What changed

  • preserve requested docs paths while comparing their canonical manifest form
  • keep nested TypeDoc index/index files distinct from their parent package index
  • add resolver and live smoke coverage for core and React Table reference indexes

Why

The docs manifest already removes one trailing /index. The route resolver removed another one while normalizing manifest entries, which collapsed valid nested TypeDoc pages. Core links redirected to /reference, framework links could redirect back to the core reference, and subsequent relative navigation could end in a 404.

Impact

Generated TypeDoc links such as /table/latest/docs/reference/index/index and /table/latest/docs/framework/react/reference/index/index now render their intended documents without cross-framework redirects.

Validation

  • pnpm test
  • direct localhost checks for core index, React index, and DebugOptions routes

Summary by CodeRabbit

  • Bug Fixes

    • Improved documentation URL handling for paths containing trailing slashes or /index.
    • Preserved valid reference and framework-prefixed documentation routes instead of redirecting unnecessarily.
    • Fixed legacy table library reference URLs to resolve successfully.
  • Tests

    • Added coverage for canonical documentation paths, manifest resolution, and legacy reference routes.

@coderabbitai

coderabbitai Bot commented Aug 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: accf0dfe-916d-4d7f-96c9-5398657d8f5c

📥 Commits

Reviewing files that changed from the base of the PR and between 22f95f9 and eb43c81.

📒 Files selected for processing (3)
  • src/utils/docs-redirects.ts
  • tests/docs-redirects.test.ts
  • tests/docs-route-smoke.test.ts

📝 Walkthrough

Walkthrough

Docs path resolution now separates render paths from canonical lookup paths. Manifest normalization and matching handle terminal /index segments. Tests cover TypeDoc reference routes, framework-prefixed routes, and nested index paths.

Changes

Documentation route canonicalization

Layer / File(s) Summary
Canonical lookup and manifest normalization
src/utils/docs-redirects.ts
Canonical paths now support manifest, framework, and section-index lookups while preserving the requested normalized path for rendering.
Index route coverage
tests/docs-redirects.test.ts, tests/docs-route-smoke.test.ts
Tests verify direct rendering for TypeDoc reference paths, framework-prefixed paths, and nested /index/index routes.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to eb43c

This localized route-resolution change preserves nested TypeDoc pages and adds targeted coverage; no actionable merge-blocking risk remains beyond normal checks and review.

Possibly related PRs

Suggested labels: source-audit

Suggested reviewers: tannerlinsley

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: fixing nested TypeDoc index route resolution.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/fix-nested-typedoc-index-routes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 14, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
tanstack-com eb43c81 Commit Preview URL

Branch Preview URL
Aug 14 2026, 08:09 PM

@KevinVandy
KevinVandy marked this pull request as ready for review August 14, 2026 20:08
@tannerlinsley
tannerlinsley merged commit f35cb79 into main Aug 14, 2026
7 checks passed
@tannerlinsley
tannerlinsley deleted the agent/fix-nested-typedoc-index-routes branch August 14, 2026 21:23
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.

2 participants