docs(readme): lead with positioning and code, plugin-first Gradle setup#245
Merged
Conversation
Optimize the README for adoption:
- Open with the site's positioning line (type-safe, SQL-first, no
proxies/N+1/persistence context) and a concise Kotlin sample above the
fold, so code appears by line 13 instead of 51.
- Drop the generic 'Core ORM benefits' bullet list; the comparison table
already makes the case better.
- Kotlin-first: a 'More Kotlin' section (block DSL, Flow, transactions)
replaces the parallel Kotlin/Java blocks; Java kept as a pointer.
- Remove em dashes and smart quotes to match site copy conventions.
Gradle setup:
- Lead with the Storm Gradle plugin (id("st.orm")) as the one-block
install; keep the BOM + per-module path as the without-the-plugin
fallback (and for Maven).
- Use a literal version in the README (GitHub serves it raw, so the
@@STORM_VERSION@@ placeholder used in docs/ would render literally).
release.yml now rewrites the README version in the same commit as the
docs snapshot, so it is never bumped by hand.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Optimizes the README for adoption, aligning its positioning with the website and getting code above the fold.
Adoption rewrite
Flowstreaming, coroutine transactions) replaces the old side-by-side Kotlin/Java code blocks; Java stays clearly supported through a pointer to the Java example and the String Templates guide.Gradle setup, plugin-first
plugins { id("st.orm") version "1.13.0" }) as the one-block install; the BOM + per-module declarations remain as the "without the plugin" fallback and for Maven.@@STORM_VERSION@@substitution (the placeholder thedocs/build uses), so the README currently shows that token literally to visitors. The examples now carry a real version (1.13.0), andrelease.yml'sversion-docsjob rewrites it to the released tag in the same commit as the docs snapshot, so it is never bumped by hand. The Kotlin and KSP plugin versions are left untouched by the sync (verified).Structurally unchanged below the setup section: the module table, AI-assisted development, examples, the full documentation index, database support, requirements, community, and license.