Skip to content

feat(website): quickstart graph example, snippet variants, and comparison updates#194

Merged
zantvoort merged 1 commit into
mainfrom
feat/website-quickstart-refresh
Jul 7, 2026
Merged

feat(website): quickstart graph example, snippet variants, and comparison updates#194
zantvoort merged 1 commit into
mainfrom
feat/website-quickstart-refresh

Conversation

@zantvoort

Copy link
Copy Markdown
Collaborator

Summary

Quickstart

  • Retitled to "Zero to Storm / in 5 minutes." and reworked the example to show the entity graph: two linked entities (Director, Movie with @FK), multiple inserts, and a query across the relation (Movie_.director.name like "Chris%"), with the generated single-statement join visible via Show SQL
  • Setup now leads with the Gradle build; the Storm CLI one-liner (AI-assisted setup) follows as a secondary suggestion, with a note that it runs from the workspace root
  • Closing row pairs "Build a real app" with a star link

Snippet variants and copy buttons

  • editor() in the shared tutorial theme gains a title-bar variant selector and a Copy button (copy text derived from the highlighted code, so snippets and clipboard content cannot drift)
  • Install snippets selectable per Kotlin line (2.0–2.4, matching KSP and storm-compiler-plugin versions; shared KOTLIN_VARIANTS)
  • DDL selectable per database: H2, PostgreSQL, MySQL/MariaDB, Oracle, SQL Server, SQLite (shared DATABASE_VARIANTS); fixes the previous script's MySQL-only AUTO_INCREMENT, which H2 2.x rejects outside compatibility modes, and gives MySQL its required table-level FOREIGN KEY
  • Applied on the quickstart and the build-a-REST-API tutorial

Landing page

  • Hero gets a button row: a gradient "Try it in 5 minutes" primary linking to the quickstart and a secondary linking to the comparison; tightened phone layout
  • All GitHub links across the site open in a new tab (rel="noopener")

Build-a-REST-API tutorial

  • Routes use repository<>() consistently: new one-line FolderRepository, insertAndFetch for the create path

Comparison

  • Website matrix: new rows for session state, deferred loading, standalone transactions, row mapping, and query across relations (effort-focused wording, competitors credited where they have an answer); Jimmer covered in the framework cards instead of the matrix; Storm column highlighted with the brand gradient
  • Docs comparison (current and 1.12.0): session state and query-across-relations rows added; "SQL Templates" row renamed to "SQL / SQL templates" and now credits each framework's raw SQL support

Test plan

  • npm run build passes; all pages verified rendering on a local docusaurus serve (landing, quickstart, comparison, tutorial, /docs/comparison, /docs/next/comparison)
  • Verified variant selectors switch panes and the Copy button follows the selected variant

…ison updates

- Quickstart: retitle to "Zero to Storm in 5 minutes", model two linked
  entities and query across the relation, lead the setup with the Gradle
  build (Storm CLI as a follow-up suggestion), and close with a star link
- Snippet variants: Kotlin 2.0-2.4 install snippets and per-database DDL
  (H2, PostgreSQL, MySQL/MariaDB, Oracle, SQL Server, SQLite) selectable
  in the editor title bar; copy buttons on the copyable blocks (shared
  editor() gains variants and copy support)
- Fix quickstart DDL that used MySQL-only AUTO_INCREMENT, which H2 2.x
  rejects outside compatibility modes
- Landing: quickstart and comparison buttons in the hero with a gradient
  primary, tightened phone layout; GitHub links open in a new tab
  site-wide
- Build-a-REST-API tutorial: same variants and copy buttons; routes use
  repository<>() consistently via a new FolderRepository and
  insertAndFetch
- Comparison page: rows for session state, deferred loading, standalone
  transactions, row mapping, and query across relations; Jimmer covered
  in the cards instead of the matrix; Storm column highlighted with the
  brand gradient
- Docs comparison (current and 1.12.0): session state and
  query-across-relations rows; the SQL row now credits each framework's
  raw SQL support
@zantvoort zantvoort merged commit 55949cd into main Jul 7, 2026
6 checks passed
@zantvoort zantvoort deleted the feat/website-quickstart-refresh branch July 7, 2026 17:58
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