Skip to content

docs: general docs updates#2118

Open
harry-whorlow wants to merge 2 commits intomainfrom
ssr-docs
Open

docs: general docs updates#2118
harry-whorlow wants to merge 2 commits intomainfrom
ssr-docs

Conversation

@harry-whorlow
Copy link
Copy Markdown
Contributor

@harry-whorlow harry-whorlow commented Apr 10, 2026

Summary by CodeRabbit

  • Documentation
    • Updated Remix server-side rendering guide to use the correct import source for form utilities.
    • Added a “Why Index as Key?” section clarifying why examples use index-based keys for array items and how that aligns component instances with form state.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cb867180-1746-4f34-8c75-a0f88a9c46ba

📥 Commits

Reviewing files that changed from the base of the PR and between f9616f9 and cdf783c.

📒 Files selected for processing (1)
  • docs/framework/react/guides/arrays.md
✅ Files skipped from review due to trivial changes (1)
  • docs/framework/react/guides/arrays.md

📝 Walkthrough

Walkthrough

Updated two documentation guides: the Remix SSR guide now imports useTransform from @tanstack/react-form-remix instead of @tanstack/react-form, and the arrays guide adds a new "Why Index as Key?" section explaining the use of key={i} for array items.

Changes

Cohort / File(s) Summary
Documentation Import Update
docs/framework/react/guides/ssr.md
Changed useTransform import source from @tanstack/react-form to @tanstack/react-form-remix.
Arrays Key Guidance
docs/framework/react/guides/arrays.md
Added a new "Why Index as Key?" section explaining the rationale for using key={i} with array field names tied to indices.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A tiny hop through docs today,
Imports nudged, and guidance laid,
Keys by index, a clear new line,
I nibble changes — all looks fine! ✨

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning No pull request description was provided. The required template sections including 'Changes', 'Checklist', and 'Release Impact' are completely missing. Add a pull request description following the template, explaining the changes made and confirming completion of the checklist and release impact items.
Title check ❓ Inconclusive The title is vague and generic, using 'general docs updates' which fails to communicate the specific fix for useTransform import in the SSR guide. Update title to be more specific, such as 'docs: fix useTransform import in SSR guide' to clearly indicate the primary change.
✅ Passed checks (1 passed)
Check name Status Explanation
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
  • Commit unit tests in branch ssr-docs

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.

@nx-cloud
Copy link
Copy Markdown

nx-cloud bot commented Apr 10, 2026

View your CI Pipeline Execution ↗ for commit cdf783c

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 33s View ↗
nx run-many --target=build --exclude=examples/** ✅ Succeeded 1s View ↗

☁️ Nx Cloud last updated this comment at 2026-04-11 08:10:32 UTC

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 10, 2026

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new bot commented Apr 10, 2026

More templates

@tanstack/angular-form

npm i https://pkg.pr.new/@tanstack/angular-form@2118

@tanstack/form-core

npm i https://pkg.pr.new/@tanstack/form-core@2118

@tanstack/form-devtools

npm i https://pkg.pr.new/@tanstack/form-devtools@2118

@tanstack/lit-form

npm i https://pkg.pr.new/@tanstack/lit-form@2118

@tanstack/react-form

npm i https://pkg.pr.new/@tanstack/react-form@2118

@tanstack/react-form-devtools

npm i https://pkg.pr.new/@tanstack/react-form-devtools@2118

@tanstack/react-form-nextjs

npm i https://pkg.pr.new/@tanstack/react-form-nextjs@2118

@tanstack/react-form-remix

npm i https://pkg.pr.new/@tanstack/react-form-remix@2118

@tanstack/react-form-start

npm i https://pkg.pr.new/@tanstack/react-form-start@2118

@tanstack/solid-form

npm i https://pkg.pr.new/@tanstack/solid-form@2118

@tanstack/solid-form-devtools

npm i https://pkg.pr.new/@tanstack/solid-form-devtools@2118

@tanstack/svelte-form

npm i https://pkg.pr.new/@tanstack/svelte-form@2118

@tanstack/vue-form

npm i https://pkg.pr.new/@tanstack/vue-form@2118

commit: cdf783c

@harry-whorlow harry-whorlow changed the title docs(react-remix-form): fix useTransform import docs: general docs updates Apr 11, 2026
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