Skip to content

docs: comparison page + name disambiguation + SEO metadata - #86

Merged
colorpulse6 merged 1 commit into
mainfrom
docs/discoverability-comparison-seo
Jun 10, 2026
Merged

docs: comparison page + name disambiguation + SEO metadata#86
colorpulse6 merged 1 commit into
mainfrom
docs/discoverability-comparison-seo

Conversation

@colorpulse6

Copy link
Copy Markdown
Owner

Discoverability improvements — all in-repo, no external publishing, no package source changes.

What

  • Comparison page (/docs/comparison) — "El Form vs React Hook Form, Formik & TanStack Form." Honest feature matrix + when-to-pick-each. Targets the winnable "RHF alternative" / "el-form vs X" long-tail that LLMs-with-search and listicle authors cite.
  • Name disambiguation (README + docs intro) — El Form (React) vs Vue Element Plus's <el-form>, which currently dominates the bare search term.
  • Docs meta SEO — richer tagline (default meta description), themeConfig.metadata (keywords + twitter:card), JSON-LD SoftwareApplication via headTags.
  • Fixed the broken CI status badge (deprecated shields workflow/status endpoint → actions/workflow/status/...ci.yml).
  • (Separately, already applied) 15 GitHub repo topics added for topic-page / awesome-list discovery.

Accuracy

An independent reviewer verified every el-form capability claim against packages/ source and flagged one overstatement (AutoForm generation is Zod-only) and one wording bug (focus-on-error is on-by-default, not opt-in) — both fixed before commit. Competitor characterizations were checked as fair and well-hedged.

Verification

pnpm --filter el-form-docs build succeeds (no broken links); sitemap includes the new page; JSON-LD + keywords present in built output.

🤖 Generated with Claude Code

Discoverability improvements (no package source changes):

- New comparison page (docs/comparison) — honest "El Form vs React Hook Form,
  Formik & TanStack Form" with a feature matrix and when-to-pick-each guidance.
  Targets the "RHF alternative" / "el-form vs X" long-tail that LLMs and listicle
  authors cite. Every el-form claim verified against source; AutoForm generation
  scoped to Zod (validation stays schema-agnostic).
- Name disambiguation (README + docs intro) — clarifies El Form (React) is
  distinct from Vue Element Plus's <el-form>, which dominates the bare term.
- Docs meta SEO — richer tagline (default description), themeConfig.metadata
  (keywords + twitter:card), and JSON-LD SoftwareApplication via headTags so
  search engines/LLMs classify it as a dev tool.
- Fixed the broken CI status badge URL (deprecated shields workflow endpoint).

Docs build verified clean; sitemap includes the new page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@colorpulse6
colorpulse6 merged commit a1e0198 into main Jun 10, 2026
8 checks passed
@colorpulse6
colorpulse6 deleted the docs/discoverability-comparison-seo branch June 10, 2026 06:09
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