docs(svelte): add Form Composition guide and example to site nav by Tyson910 · Pull Request #2138 · TanStack/form

Tyson910 · 2026-04-24T18:04:27Z

🎯 Changes

Add the Svelte "Form Composition" guide and "Large Form" example to the docs site navigation.

Both docs/framework/svelte/guides/form-composition.md and examples/svelte/large-form/ already exist (added in #1713) but were never added to docs/config.json, so they don't appear on the website.

This brings Svelte in line with React, Angular, and Solid which all have their Form Composition guide and example listed.

Note: other orphaned docs

While investigating this, I found 39 total doc files across all frameworks that exist on disk but aren't wired into docs/config.json. This PR only addresses the Svelte gaps, but here's the full picture:

Guides missing from nav:

angular/guides/listeners.md
angular/guides/submission-handling.md
solid/guides/devtools.md
solid/guides/submission-handling.md
vue/guides/listeners.md
vue/guides/submission-handling.md

Auto-generated API reference docs missing from nav (32 files):
Spread across React (13), Solid (13), Angular (3), and Vue (4) — mostly newer API surface like createFormHook, WithFormProps, useFieldGroup, etc.

Happy to open follow-up PRs for those if helpful.

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

💡 Idea: prevent orphaned docs in the future

The existing test:docs script (scripts/verify-links.ts) checks that links inside markdown files are valid, but it doesn't check the reverse — that doc files on disk have a corresponding entry in docs/config.json. That's how these slipped through.

A small addition to verify-links.ts (or a separate script added to the test:docs target) could catch this:

// For each .md in docs/framework/*, ensure it has a matching "to" in config.json
const configPaths = new Set(extractAllToPaths('docs/config.json'))
const docFiles = glob('docs/framework/**/*.md')

for (const file of docFiles) {
  const configPath = file.replace('docs/', '').replace('.md', '')
  if (!configPaths.has(configPath)) {
    console.warn(`Orphaned doc: ${file} has no entry in docs/config.json`)
  }
}

Would that be useful? Happy to open a follow-up PR if so.

Summary by CodeRabbit

Documentation
- Added new Form Composition guide to Svelte documentation.
- Added large form example to Svelte resources.
- Updated navigation to include new guides and examples for developers building forms with Svelte.

Both docs/framework/svelte/guides/form-composition.md and examples/svelte/large-form/ already exist (added in TanStack#1713) but were never wired into docs/config.json, so they don't appear on the website.

coderabbitai · 2026-04-24T18:04:43Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a1a45ad7-ae7f-4b5a-b211-f5b0ea95b146

📥 Commits

Reviewing files that changed from the base of the PR and between 1cdd97a and 91346dd.

📒 Files selected for processing (1)

docs/config.json

📝 Walkthrough

Walkthrough

The documentation configuration file was updated to include two new navigation routes for Svelte documentation: a guide on form composition and an example of a large form. No functional code logic was altered.

Changes

Cohort / File(s)	Summary
Documentation Navigation Configuration `docs/config.json`	Added two new navigation routes to the Svelte section: `framework/svelte/guides/form-composition` in Guides and `framework/svelte/examples/large-form` in Examples.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A rabbit hops through docs so neat,
Adding paths for forms complete,
New guides and examples in a row,
Navigation flourishing as it grows! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically summarizes the main change: adding Form Composition guide and Large Form example to Svelte navigation in docs/config.json.
Description check	✅ Passed	The description fully covers the required template sections: Changes section explains the update and context, Checklist items are completed, and Release Impact correctly identifies this as docs-only with no changeset needed.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ 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.}

nx-cloud · 2026-04-29T13:43:52Z

View your CI Pipeline Execution ↗ for commit 91346dd

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

☁️ Nx Cloud last updated this comment at 2026-04-29 13:44:49 UTC

pkg-pr-new · 2026-04-29T13:44:32Z

More templates

@tanstack/angular-form

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

@tanstack/form-core

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

@tanstack/form-devtools

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

@tanstack/lit-form

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

@tanstack/react-form

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

@tanstack/react-form-devtools

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

@tanstack/react-form-nextjs

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

@tanstack/react-form-remix

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

@tanstack/react-form-start

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

@tanstack/solid-form

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

@tanstack/solid-form-devtools

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

@tanstack/svelte-form

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

@tanstack/vue-form

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

commit: 91346dd

LeCarbonator · 2026-04-29T13:50:21Z

Thanks!

Tyson910 · 2026-04-29T14:38:48Z

Thanks!

@LeCarbonator any interest in the prevent orphaned docs in the future script? I can open a PR if so

LeCarbonator · 2026-04-29T14:42:08Z

Thanks!

@LeCarbonator any interest in the prevent orphaned docs in the future script? I can open a PR if so

Contributions are always welcome! However, for this case, it would be better to include it in TanStack Config so that form isn't the only one with the orphaned docs guard.

It could also be that form simply missed out on such a feature and had those docs slip by accidentally. Either way, I'll bring it up to the config maintainers.

docs(svelte): add Form Composition guide and example to site nav

91346dd

Both docs/framework/svelte/guides/form-composition.md and examples/svelte/large-form/ already exist (added in TanStack#1713) but were never wired into docs/config.json, so they don't appear on the website.

LeCarbonator merged commit 93be6f0 into TanStack:main Apr 29, 2026
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(svelte): add Form Composition guide and example to site nav#2138

docs(svelte): add Form Composition guide and example to site nav#2138
LeCarbonator merged 1 commit into
TanStack:mainfrom
Tyson910:docs/svelte-form-composition-nav

Tyson910 commented Apr 24, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 24, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

nx-cloud Bot commented Apr 29, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Apr 29, 2026

Uh oh!

Uh oh!

LeCarbonator commented Apr 29, 2026

Uh oh!

Tyson910 commented Apr 29, 2026

Uh oh!

LeCarbonator commented Apr 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

Tyson910 commented Apr 24, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎯 Changes

Note: other orphaned docs

✅ Checklist

🚀 Release Impact

💡 Idea: prevent orphaned docs in the future

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

nx-cloud Bot commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Apr 29, 2026

Uh oh!

Uh oh!

LeCarbonator commented Apr 29, 2026

Uh oh!

Tyson910 commented Apr 29, 2026

Uh oh!

LeCarbonator commented Apr 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Tyson910 commented Apr 24, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 24, 2026 •

edited

Loading

nx-cloud Bot commented Apr 29, 2026 •

edited

Loading