fix(docs): correct reference page path casing#310
fix(docs): correct reference page path casing#310eklavya-raj wants to merge 1 commit intoTanStack:mainfrom
Conversation
📝 WalkthroughWalkthroughUpdated Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/config.json (1)
83-169: Consider adding a CI route-validation check for sidebartotargets.This section is manually maintained and can drift from generated docs again. A lightweight check that verifies each
topath exists underdocs/referencewould 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.
🎯 Changes
✅ Checklist
pnpm test:pr.🚀 Release Impact
Summary by CodeRabbit