docs: align docs, skills, and site copy with 1.13.0#237
Merged
Conversation
An audit of every docs page, AI skill file, and website source against the 1.13.0 changes. Corrections: - The Java repository skill claimed the Java API has no Storm-managed transactions; since 1.13 Transactions.transaction(...) is the programmatic API, cooperating with Spring's @transactional through the bridge. The section is rewritten for both styles and the standalone JDBC story. - The setup and Kotlin repository skills and the Exposed-Ktor tutorial still recommended the removed storm-ktor-koin module; they now describe the built-in dependency injection and point Koin users at the integration docs recipe. - The last Kotlin property-override snippet (repositories.md) moved to the 1.13 method override; plain-Spring scanning guidance now names @EnableStormRepositories and the configuring constructors. Coverage: - installation.md gains Observability and Testing module tables (storm-micrometer, storm-test, storm-spring-boot-test-autoconfigure); the README stack table, the Gradle plugin mention, and CONTRIBUTING's project structure now list the new modules. - metrics.md and the configuration monitoring tip cross-reference the Micrometer observations. Site copy style: em dashes rewritten with colons, commas, and periods across the landing, quickstart, and tutorial pages.
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.
A thorough audit of every docs page, AI skill file, and website source against the accumulated 1.13.0 changes, executed as three parallel sweeps (docs/, website/, repo-level files) armed with the full catalog of 1.13 renames, removals, and additions.
Corrections (were actively wrong)
website/static/skills/storm-repository-java.mdinstructed AI assistants that the Java API has no Storm-managed transaction API and to never writetransaction(...)— the opposite of 1.13's programmaticTransactions.transaction(...). Rewritten with the Java API, the Spring cooperation story, and the standalone JDBC story.storm-setup.md,storm-repository-kotlin.md, and the Exposed-Ktor tutorial page still recommended the removedstorm-ktor-koinmodule; they now describe Ktor's built-in dependency injection (by dependencies) and point Koin users at the integration docs recipe.docs/repositories.mdcarried the last Kotlin property-override snippet (override val repositoryBasePackages), now the 1.13 method override; plain-Spring scanning guidance across the skills now names@EnableStormRepositoriesand the configuring constructors.Coverage gaps filled
docs/installation.md: new Observability and Testing module tables (storm-micrometer,storm-test,storm-spring-boot-test-autoconfigure).id("st.orm")) mention; CONTRIBUTING's project structure lists the three new modules.docs/metrics.mdand the configuration monitoring tip now cross-reference the Micrometer observations alongside JMX.Site copy style
Em dashes rewritten with colons, commas, and periods across the landing, quickstart, and REST-API tutorial pages (18 occurrences; historical blog posts untouched).
Verified clean
All remaining docs pages (transactions, spring-integration, ktor-integration, testing, configuration, error-handling, ai, getting-started), the landing page and comparison matrix snippets, tutorial version constants, sidebars and Docusaurus config, the changelog's Unreleased section, and the other 20 skill files. Release-time items deliberately excluded:
versions.jsongains 1.13.0 andllms-full.txtregenerates as part of the release flow.Related: the docs deploy failure was fixed separately on main (the Javadoc aggregate now excludes the module-descriptor-free test-autoconfigure module); the workflow is green again.