Skip to content

Add React comparison guide and link it in the menu#102

Merged
fabian-hiller merged 7 commits into
mainfrom
react-comparison-guide
May 20, 2026
Merged

Add React comparison guide and link it in the menu#102
fabian-hiller merged 7 commits into
mainfrom
react-comparison-guide

Conversation

@fabian-hiller
Copy link
Copy Markdown
Member

@fabian-hiller fabian-hiller commented May 20, 2026

Fix #101

Copilot AI review requested due to automatic review settings May 20, 2026 01:39
@vercel
Copy link
Copy Markdown

vercel Bot commented May 20, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
formisch Ready Ready Preview, Comment May 20, 2026 3:18am

Request Review

@dosubot dosubot Bot added size:M This PR changes 30-99 lines, ignoring generated files. documentation Improvements or additions to documentation labels May 20, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 20, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7762b258-8fe1-45cc-97e9-e39c06a020cc

📥 Commits

Reviewing files that changed from the base of the PR and between aa7c4dd and 873a7b2.

📒 Files selected for processing (1)
  • website/src/routes/(docs)/solid/guides/(get-started)/comparison/index.mdx
✅ Files skipped from review due to trivial changes (1)
  • website/src/routes/(docs)/solid/guides/(get-started)/comparison/index.mdx

Walkthrough

This PR adds framework-specific "Comparison" documentation pages (React, Solid, Svelte, Vue), inserts "Comparison" links into the guides menus and introduction pages, and updates the top-level README and per-framework READMEs/introduction copy to emphasize the framework-agnostic core with framework-native reactivity blocks, a modular methods API (~2.5 kB starting), and end-to-end type-safety for nested paths/field arrays.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Out of Scope Changes check ⚠️ Warning The PR makes several out-of-scope changes beyond the React comparison guide: it updates comparison/vision text across 8 README files and 6 additional framework-specific guide pages (Solid, Svelte, Vue), which are not required by issue #101. Limit this PR to the React comparison guide and menu update. Move the framework README updates and other framework guides to a separate documentation refactoring PR.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Add React comparison guide and link it in the menu' accurately describes the main changes: adding a comparison guide page for React and updating the navigation menu.
Description check ✅ Passed The description 'Fix #101' is minimal but directly relates to implementing the linked issue's requirements for a comparison page.
Linked Issues check ✅ Passed The PR implements the core requirement of issue #101 by adding a React comparison guide with an 'At a glance' table, decision guidance, and migration information, plus linking it in the menu.
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.


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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
website/src/routes/(docs)/react/guides/(get-started)/comparison/index.mdx (1)

27-27: ⚡ Quick win

Add version/date context for bundle-size numbers.

This row is likely to drift over time. Add a short qualifier (e.g., “as of May 2026”) and measurement basis/toolchain so readers don’t treat these as timeless constants.

Proposed doc tweak
-| Bundle size (min+gzip) | From ~2.5 kB                            | ~12 kB                              | ~15 kB                                  |
+| Bundle size (min+gzip, as of May 2026) | From ~2.5 kB | ~12 kB | ~15 kB |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@website/src/routes/`(docs)/react/guides/(get-started)/comparison/index.mdx at
line 27, Update the "Bundle size (min+gzip)" table row in index.mdx to include a
date/version qualifier and measurement basis so the numbers are not treated as
permanent; e.g., append " (min+gzip, measured with [toolchain] as of [Month
Year])" to the header or each cell — locate the row containing the text "Bundle
size (min+gzip)" and modify it to include the qualifier (for example: "Bundle
size (min+gzip, measured with webpack 5 + terser, as of May 2026)").
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@website/src/routes/`(docs)/react/guides/(get-started)/comparison/index.mdx:
- Line 27: Update the "Bundle size (min+gzip)" table row in index.mdx to include
a date/version qualifier and measurement basis so the numbers are not treated as
permanent; e.g., append " (min+gzip, measured with [toolchain] as of [Month
Year])" to the header or each cell — locate the row containing the text "Bundle
size (min+gzip)" and modify it to include the qualifier (for example: "Bundle
size (min+gzip, measured with webpack 5 + terser, as of May 2026)").

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 90e7b2d3-3128-434f-88e8-4135d6edc0bc

📥 Commits

Reviewing files that changed from the base of the PR and between 6c0a691 and 297d8b5.

📒 Files selected for processing (3)
  • website/src/routes/(docs)/react/guides/(get-started)/comparison/index.mdx
  • website/src/routes/(docs)/react/guides/(get-started)/introduction/index.mdx
  • website/src/routes/(docs)/react/guides/menu.md

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

Re-trigger cubic

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new React “Comparison” guide and surfaces it in the React docs navigation to help users evaluate Formisch vs. React Hook Form and TanStack Form.

Changes:

  • Add a new /react/guides/comparison/ page with a short comparison table and decision guidance.
  • Link the new guide from the React guides menu.
  • Add a callout link to the comparison guide from the React introduction page.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
website/src/routes/(docs)/react/guides/menu.md Adds “Comparison” entry to the React guides menu.
website/src/routes/(docs)/react/guides/(get-started)/introduction/index.mdx Links readers to the new comparison guide from the introduction.
website/src/routes/(docs)/react/guides/(get-started)/comparison/index.mdx Introduces the new comparison guide content and links to the long-form blog article.
Comments suppressed due to low confidence (1)

website/src/routes/(docs)/react/guides/(get-started)/comparison/index.mdx:44

  • This is an internal link to an existing blog route but uses Markdown link syntax (plain <a>). Prefer the Link component for internal navigation (consistent with other guides and avoids full reloads).
For a side-by-side mapping of common React Hook Form APIs to their Formisch equivalents, see the migration section of the [comparison article](/blog/react-form-library-comparison/).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread website/src/routes/(docs)/react/guides/(get-started)/comparison/index.mdx Outdated
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
website/src/routes/(docs)/react/guides/(get-started)/comparison/index.mdx (1)

27-27: ⚠️ Potential issue | 🟠 Major | ⚡ Quick win

TanStack Form bundle size claim needs clarification.

The comparison table states TanStack Form at "~15 kB," but current documentation reveals the library unconditionally imports devtools dependencies in production builds, adding approximately 11.6 kB of code that doesn't tree-shake away. The actual production bundle footprint is framework-dependent and more complex than a single figure suggests. Update the claim to reflect the production overhead or link to bundler analysis recommendations, as the ~15 kB figure doesn't capture the current documented behavior.

React Hook Form's "~12 kB" is accurate (current: 11.2 kB minified+gzipped). Formisch's "~2.5 kB" is confirmed across all framework documentation.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@website/src/routes/`(docs)/react/guides/(get-started)/comparison/index.mdx at
line 27, Update the bundle-size cell for "TanStack Form" in the comparison table
row containing "Bundle size (min+gzip)" to clarify that the ~15 kB figure is
misleading: state that TanStack Form currently unconditionally imports devtools
in production (adding ~11.6 kB) so actual production footprint is framework- and
bundler-dependent, and either replace "~15 kB" with a clearer note like "varies;
+~11.6 kB devtools included in prod" or add a footnote/link to bundler analysis
recommendations and the library docs; keep the existing "~12 kB" for React Hook
Form and "~2.5 kB" for Formisch unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@website/src/routes/`(docs)/react/guides/(get-started)/comparison/index.mdx:
- Line 27: Update the bundle-size cell for "TanStack Form" in the comparison
table row containing "Bundle size (min+gzip)" to clarify that the ~15 kB figure
is misleading: state that TanStack Form currently unconditionally imports
devtools in production (adding ~11.6 kB) so actual production footprint is
framework- and bundler-dependent, and either replace "~15 kB" with a clearer
note like "varies; +~11.6 kB devtools included in prod" or add a footnote/link
to bundler analysis recommendations and the library docs; keep the existing "~12
kB" for React Hook Form and "~2.5 kB" for Formisch unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9fa2e76d-37ff-4c54-95bd-bec9018945d7

📥 Commits

Reviewing files that changed from the base of the PR and between 297d8b5 and 10dd0a3.

📒 Files selected for processing (1)
  • website/src/routes/(docs)/react/guides/(get-started)/comparison/index.mdx

@dosubot dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels May 20, 2026
@fabian-hiller fabian-hiller requested a review from Copilot May 20, 2026 03:08
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.

Comment thread website/src/routes/(docs)/solid/guides/(get-started)/comparison/index.mdx Outdated
@fabian-hiller fabian-hiller merged commit 3845f26 into main May 20, 2026
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a decision-oriented comparison page for choosing a form library

2 participants