Skip to content

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

Open
Tyson910 wants to merge 1 commit intoTanStack:mainfrom
Tyson910:docs/svelte-form-composition-nav
Open

docs(svelte): add Form Composition guide and example to site nav#2138
Tyson910 wants to merge 1 commit intoTanStack:mainfrom
Tyson910:docs/svelte-form-composition-nav

Conversation

@Tyson910
Copy link
Copy Markdown

@Tyson910 Tyson910 commented Apr 24, 2026

🎯 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
Copy link
Copy Markdown

coderabbitai Bot commented Apr 24, 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: 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.

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