[design] README Quick Start corrections#13
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3ee221d023
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - Toolchain in use: Java 21 (`java -version`), sbt 1.11.3 | ||
| (`project/build.properties`). The README's "Java 17+" / "sbt 1.8+" are | ||
| stated as minimums — keep unless shown to be wrong; do not regress them. | ||
| - Node.js prerequisite for the frontend. |
There was a problem hiding this comment.
Correct the verified Node prerequisite
This marks the existing frontend Node.js prerequisite as verified, but the checked-in lockfile requires newer Node for the frontend toolchain: frontend/package-lock.json lists vite 7.1.2 and @vitejs/plugin-vue 6.0.1 with engines ^20.19.0 || >=22.12.0. If the README keeps its current Node.js 18+ prerequisite, contributors on Node 18 will fail during npm install/npm run dev, so the design should require updating the Quick Start minimum instead of treating that fact as already correct.
Useful? React with 👍 / 👎.
README Quick Start corrections
Problem
The root
README.mdhas a "🚀 Quick Start" section that looks complete butmisleads a first-time contributor:
Architecture → Technology Stack, but the build is Scala 3.7.1
(
build.sbt: ThisBuild / scalaVersion := "3.7.1")..envsetup, backend/frontendrun steps, ports) is spread across the file and has not been verified to be
internally consistent and correct against the repo.
Net effect: a new user following the steps top-to-bottom can hit an incorrect
fact and stall before getting a server running.
Approach
A documentation-only revision of
README.md. No source, build, or.env.examplechanges.Correct the Scala version everywhere it appears. Replace "Scala 2.13"
with "Scala 3" in both the Quick Start prerequisites and the
Architecture → Technology Stack section. Plain "Scala 3" is preferred over
pinning "3.7.1" in prose so the README does not drift on the next bump; the
exact version stays in
build.sbt.Verify and correct the remaining Quick Start facts against the repo, and
leave correct ones unchanged. Verified during design:
java -version), sbt 1.11.3(
project/build.properties). The README's "Java 17+" / "sbt 1.8+" arestated as minimums — keep unless shown to be wrong; do not regress them.
.envsetup:.env.exampleexists in the repo root;cp .env.example .envis correct.
sbt szorkStartandsbt "~szorkStart".cd frontend,npm install,npm run dev; dev server is Viteon port 3090 (
frontend/vite.config.mts), URLhttp://localhost:3090.SzorkConfig.scala) and WebSocket 9002(
SzorkServer.scala) — already correct in the README.Keep the section tight and linear — a single clone → configure → run
path, ordered so the steps work in sequence.
Decisions
new file.
part of this work.
build.sbtremains the single source of truth for the exact version.Scope: single piece
This is one small, internally-consistent edit to a single file, comfortably
reviewable in one sitting. The feature is therefore a single piece (
p1).Splitting it into setup/edit/cleanup stages would add overhead without value.
Non-goals
QUICKSTART.md— the README section is the home for this.Contributors, License) beyond the version corrections noted above.
.env.example.