Skip to content

docs: fix API tab 404 by removing broken reference/index links#2253

Open
geonhwiii wants to merge 1 commit into
TanStack:mainfrom
geonhwiii:docs/fix-api-tab-404-reference-index
Open

docs: fix API tab 404 by removing broken reference/index links#2253
geonhwiii wants to merge 1 commit into
TanStack:mainfrom
geonhwiii:docs/fix-api-tab-404-reference-index

Conversation

@geonhwiii

@geonhwiii geonhwiii commented Jul 22, 2026

Copy link
Copy Markdown

Summary

Fixes #2226


Note

If docs/reference/index.md and docs/framework/*/reference/index.md should actually be shown in the docs UI, more changes will likely be needed.

Please feel free to suggest edits! Thanks!


✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Closes the API tab 404 by dropping sidebar entries that point at
reference/index, which tanstack.com cannot resolve to index.md.
@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The documentation API navigation removes the top-level JavaScript Reference entry and framework-specific Reference index entries for React, Preact, Vue, Solid, Lit, and Angular.

Changes

API navigation cleanup

Layer / File(s) Summary
Remove reference index entries
docs/config.json
Removes intermediate JavaScript and framework Reference navigation items while retaining the existing API classes, functions, variables, and types.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Removing the broken reference/index sidebar entries addresses #2226 by routing the API tab to working docs pages instead of 404s.
Out of Scope Changes check ✅ Passed The change is limited to docs navigation cleanup and stays within the stated goal of fixing the API tab 404.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly matches the main change: removing broken API sidebar links to fix the docs 404.
Description check ✅ Passed The description covers the required changes, checklist, and release impact, with only minor heading differences from the template.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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.

Documentation API Link not Found

1 participant