Skip to content

fix(docs): correct reference page path casing#310

Open
eklavya-raj wants to merge 1 commit intoTanStack:mainfrom
eklavya-raj:fix/docs-reference-route-casing
Open

fix(docs): correct reference page path casing#310
eklavya-raj wants to merge 1 commit intoTanStack:mainfrom
eklavya-raj:fix/docs-reference-route-casing

Conversation

@eklavya-raj
Copy link
Copy Markdown

@eklavya-raj eklavya-raj commented Apr 16, 2026

🎯 Changes

Screenshot 2026-04-16 at 5 33 30 AM
  • This happened because the API reference sidebar config used incorrect route casing for generated docs pages.
  • This change updates those paths to the correct routes, fixing the broken page.

✅ 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).

Summary by CodeRabbit

  • Documentation
    • Fixed API Reference navigation links by correcting casing to match documentation page names, ensuring users can reliably access the intended reference documentation.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 16, 2026

📝 Walkthrough

Walkthrough

Updated docs/config.json API Reference navigation URLs by capitalizing path segments to match documentation casing conventions. Multiple interface, type alias, and function route targets were adjusted (e.g., atomAtom, createatomcreateAtom). No structural changes were made.

Changes

Cohort / File(s) Summary
Configuration URL Updates
docs/config.json
API Reference navigation target URLs corrected with proper casing for interfaces, type aliases, and functions to match documentation conventions (e.g., reference/interfaces/atomreference/interfaces/Atom, reference/functions/createatomreference/functions/createAtom).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

With whiskers twitching, paths so bright,
Capitalizing every site,
Atom, Store, and Async too,
Documentation fresh and new! 🐰

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main change: correcting API reference path casing in the docs configuration.
Description check ✅ Passed The description includes all required sections with sufficient detail about the problem, solution, and verification. Both checklist items are completed, and the release impact is properly marked.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ 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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
docs/config.json (1)

83-169: Consider adding a CI route-validation check for sidebar to targets.

This section is manually maintained and can drift from generated docs again. A lightweight check that verifies each to path exists under docs/reference would prevent regressions like this.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/config.json` around lines 83 - 169, The sidebar entries under "API
Reference" contain manual "to" paths (e.g., "reference/index",
"reference/functions/createAtom", "reference/interfaces/Atom") that can drift
from generated docs; add a CI validation step (e.g., a GitHub Actions job or npm
script called validateSidebarLinks) which reads docs/config.json, extracts every
children[].to value under the "API Reference" section, and fails if any
referenced file/path does not exist under docs/reference; implement the check as
a small Node/Python script (validateSidebarLinks) invoked in CI to return
non-zero on missing targets and wire it into the CI workflow.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/config.json`:
- Around line 83-169: The sidebar entries under "API Reference" contain manual
"to" paths (e.g., "reference/index", "reference/functions/createAtom",
"reference/interfaces/Atom") that can drift from generated docs; add a CI
validation step (e.g., a GitHub Actions job or npm script called
validateSidebarLinks) which reads docs/config.json, extracts every children[].to
value under the "API Reference" section, and fails if any referenced file/path
does not exist under docs/reference; implement the check as a small Node/Python
script (validateSidebarLinks) invoked in CI to return non-zero on missing
targets and wire it into the CI workflow.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f0a565b4-8655-4d79-9f33-ba3c05da1d2c

📥 Commits

Reviewing files that changed from the base of the PR and between 840b9d0 and e1b5638.

📒 Files selected for processing (1)
  • docs/config.json

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.

1 participant