[v2] Alpha docs improvements - #2283
Conversation
* docs(config): remove nav entries pointing at non-existent reference pages Six sidebar entries in docs/config.json referenced reference pages that do not exist, so each rendered as a 404. FieldMeta, FieldState and FieldInfo lost their generated pages in 6a73479 without config.json being updated to match. useTransform is not exported from @tanstack/react-form, and vue/solid never had UseField/CreateField types. Repoint the FieldMeta entry to AnyFieldMeta, the surviving public field-metadata type, and drop the rest. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017z89Nb8dzFPu7VnsvN2VA9 * chore(scripts): verify docs/config.json nav targets in verify-links verify-links only extracted links written inside .md files, so sidebar entries in docs/config.json were never checked and could point at pages that no longer exist without failing CI. Walk every `to` in the nav config and resolve it the same way markdown links are resolved, including the framework examples directory mapping. Failures report the nav breadcrumb so the offending entry is easy to locate. The shared resolution logic is extracted into resolveDocTarget so the two checks cannot drift apart. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017z89Nb8dzFPu7VnsvN2VA9 * fix(scripts): fail verify-links when the check itself throws The rejection handler only logged, so Node still exited 0. Reading or parsing docs/config.json can now throw, which meant test:docs could pass while the navigation check never ran. Confirmed by pointing the script at malformed and missing config files: both exited 0 before this change and exit 1 after. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017z89Nb8dzFPu7VnsvN2VA9 --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com> # Conflicts: # docs/config.json
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
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 |
|
View your CI Pipeline Execution ↗ for commit 8df110e
☁️ Nx Cloud last updated this comment at |
🚀 Changeset Version PreviewNo changeset entries found. Merging this PR will not cause a version bump for any packages. |
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## alpha #2283 +/- ##
========================================
Coverage ? 91.82%
========================================
Files ? 20
Lines ? 269
Branches ? 40
========================================
Hits ? 247
Misses ? 21
Partials ? 1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Merges the following into
alphafrommain:#2266
#2278