Skip to content

Documentation accuracy sweep: Java version claims, preview-flag test setup, stale manual versions, CONTRIBUTING claims #408

Description

@zantvoort

The Java surface stays on String Templates until the platform reintroduces them; that is accepted. The copy has to match the accepted state:

  • The README says "Java 21+" three times (badge :9, tagline :11, compatibility section :255) while docs/installation.md:46 correctly states that preview class files run on JDK 21 exactly. A JDK 25 user following the README fails at runtime. State "JDK 21 (exactly)" for the Java path everywhere; the Kotlin path genuinely is 2.0+.
  • docs/string-templates.md:195-197 promises a stable landing for the preview feature; reword to conditional on the platform.
  • docs/installation.md:188-201 shows --enable-preview on the compiler plugin only. Without it in surefire/failsafe <argLine> every test run fails; document both (the Gradle plugin already automates this).
  • There is no Maven tab for the Kotlin path at all, although this repo builds its own Kotlin modules with Maven. The manual Gradle section also pins ksp 2.0.21-1.0.28 (:129) and storm-compiler-plugin-2.0 (:138) while the plugin section above uses Kotlin 2.4.0 / KSP 2.3.10.
  • CONTRIBUTING.md claims Java is formatted with Palantir Java Format; no pom configures any formatter step (spotless does import order and whitespace only, pom.xml:166-171). It also calls the hook a pre-push hook twice; the file is .githooks/pre-commit.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions