-
Notifications
You must be signed in to change notification settings - Fork 3
[design] README Quick Start corrections #13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
rorygraves
wants to merge
1
commit into
main
Choose a base branch
from
forge/readme-quickstart/design
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # README Quick Start corrections | ||
|
|
||
| > Feature **readme-quickstart** β base branch `main`, | ||
| > branch prefix `forge`. | ||
|
|
||
| ## Pieces | ||
|
|
||
| <!-- forge:order-start --> | ||
| 1. <!-- forge:piece p1 -->**p1: Correct and tighten the README Quick Start**<!-- /forge:piece --> | ||
| <!-- forge:editable-summary p1 --> | ||
| Fix the Scala version and verify the README Quick Start steps so a new user can get running first try. | ||
| <!-- /forge:editable-summary --> | ||
| <!-- forge:status p1 -->`pending`<!-- /forge:status --> | ||
|
|
||
| <!-- forge:order-end --> | ||
|
|
||
| --- | ||
|
|
||
| *Rendered by [Forge](https://github.com/anthropics/forge) from | ||
| `manifest.json`. Edit a piece summary or reorder the list between the | ||
| `forge:order-start` / `forge:order-end` markers above, then run | ||
| `forge reconcile readme-quickstart` to import the change.* |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| # README Quick Start corrections | ||
|
|
||
| ## Problem | ||
|
|
||
| The root `README.md` has a "π Quick Start" section that looks complete but | ||
| misleads a first-time contributor: | ||
|
|
||
| - It lists **Scala 2.13** in the Quick Start prerequisites and again in | ||
| **Architecture β Technology Stack**, but the build is **Scala 3.7.1** | ||
| (`build.sbt: ThisBuild / scalaVersion := "3.7.1"`). | ||
| - The rest of the Quick Start (prerequisites, `.env` setup, backend/frontend | ||
| run 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.example` changes. | ||
|
|
||
| 1. **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`. | ||
|
|
||
| 2. **Verify and correct the remaining Quick Start facts** against the repo, and | ||
| leave correct ones unchanged. Verified during design: | ||
| - 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. | ||
| - `.env` setup: `.env.example` exists in the repo root; `cp .env.example .env` | ||
| is correct. | ||
| - Backend start: `sbt szorkStart` and `sbt "~szorkStart"`. | ||
| - Frontend: `cd frontend`, `npm install`, `npm run dev`; dev server is Vite | ||
| on **port 3090** (`frontend/vite.config.mts`), URL `http://localhost:3090`. | ||
| - Ports: HTTP **8090** (`SzorkConfig.scala`) and WebSocket **9002** | ||
| (`SzorkServer.scala`) β already correct in the README. | ||
|
|
||
| 3. **Keep the section tight and linear** β a single clone β configure β run | ||
| path, ordered so the steps work in sequence. | ||
|
|
||
| ## Decisions | ||
|
|
||
| - The human dismissed the clarifying questions, so defaults were taken: | ||
| - Interpretation: **improve the existing README Quick Start**, not create a | ||
| new file. | ||
| - **Factual accuracy is in scope** β the Scala version mismatch is fixed as | ||
| part of this work. | ||
| - Version is written as "Scala 3" (not "3.7.1") in prose to avoid future drift; | ||
| `build.sbt` remains 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 | ||
|
|
||
| - No new standalone `QUICKSTART.md` β the README section is the home for this. | ||
| - No rewrite of unrelated README sections (Features, How It Works, About, | ||
| Contributors, License) beyond the version corrections noted above. | ||
| - No changes to source code, build files, or `.env.example`. | ||
| - No expansion into troubleshooting, Docker, or deployment docs. | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| { | ||
| "schemaVersion": 1, | ||
| "featureId": "readme-quickstart", | ||
| "title": "README Quick Start corrections", | ||
| "baseBranch": "main", | ||
| "branchPrefix": "forge", | ||
| "mode": "claude-driver", | ||
| "designPr": null, | ||
| "pieces": [ | ||
| { | ||
| "id": "p1", | ||
| "order": 1, | ||
| "title": "Correct and tighten the README Quick Start", | ||
| "summary": "Fix the Scala version and verify the README Quick Start steps so a new user can get running first try.", | ||
| "specPath": "pieces/p1.md", | ||
| "acceptanceHash": "sha256:0000000000000000000000000000000000000000000000000000000000000000", | ||
| "status": "pending", | ||
| "baseSha": null, | ||
| "prNumber": null, | ||
| "mergeCommit": null, | ||
| "mergedAt": null, | ||
| "attempts": 0 | ||
| } | ||
| ] | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| # p1 β Correct and tighten the README Quick Start | ||
|
|
||
| ## Goal | ||
|
|
||
| Revise the "π Quick Start" section of the root `README.md` (and the directly | ||
| related Scala version mention in Architecture β Technology Stack) so a brand-new | ||
| user can go from clone to a running server by following the steps top-to-bottom | ||
| with no incorrect facts. Documentation-only. | ||
|
|
||
| ## Scope | ||
|
|
||
| - Edit `README.md` only. No source, build, or `.env.example` changes. | ||
|
|
||
| ## Changes | ||
|
|
||
| 1. Replace **"Scala 2.13"** with **"Scala 3"** everywhere it appears in | ||
| `README.md`: | ||
| - Quick Start β Prerequisites. | ||
| - Architecture β Technology Stack ("Backend: Scala 2.13 β¦"). | ||
| Use plain "Scala 3" (do not pin "3.7.1" in prose). | ||
| 2. Verify each remaining Quick Start fact against the repo and correct any that | ||
| are wrong; leave correct ones unchanged: | ||
| - Prerequisites: Java, sbt, Node.js (repo toolchain is Java 21 / sbt 1.11.3; | ||
| keep the README's stated minimums unless shown wrong). | ||
| - `.env` setup: `.env.example` exists and `cp .env.example .env` is accurate. | ||
| - Backend start: `sbt szorkStart` and `sbt "~szorkStart"`. | ||
| - Frontend: `cd frontend`, `npm install`, `npm run dev`, dev URL | ||
| `http://localhost:3090`. | ||
| - Ports: HTTP 8090, WebSocket 9002. | ||
| 3. Keep the Quick Start ordered as a single linear clone β configure β run path; | ||
| do not add new top-level sections. | ||
|
|
||
| ## Acceptance criteria | ||
|
|
||
| - [ ] `README.md` contains **no occurrence of "2.13"** (case-insensitive; | ||
| `grep -ci "2\.13" README.md` returns 0). | ||
| - [ ] `README.md` refers to **Scala 3** in both the Quick Start prerequisites and | ||
| the Architecture β Technology Stack section. | ||
| - [ ] The Scala version stated for the backend is consistent with `build.sbt` | ||
| (`scalaVersion := "3.7.1"`, i.e. Scala 3); no other Scala major version is | ||
| stated. | ||
| - [ ] The `.env` setup step references `.env.example` (which exists in the repo | ||
| root) with a correct `cp .env.example .env` command. | ||
| - [ ] Backend start instructions show `sbt szorkStart` and the hot-reload | ||
| variant `sbt "~szorkStart"`. | ||
| - [ ] Frontend instructions show `cd frontend`, `npm install`, `npm run dev`, | ||
| and the dev URL `http://localhost:3090`. | ||
| - [ ] Ports referenced match the code: HTTP **8090** and WebSocket **9002**. | ||
| - [ ] The Quick Start reads as a single top-to-bottom path (Prerequisites β | ||
| Environment Setup β Backend β Frontend) with no out-of-order steps. | ||
| - [ ] Only `README.md` is modified β no changes to source code, build files, or | ||
| `.env.example`. | ||
| - [ ] Unrelated README sections (Features, How It Works, About, Contributors, | ||
| License) are unchanged except for the Scala version corrections. | ||
| - [ ] Documentation-only change with no build impact (`sbt compile` unaffected). |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.jsonlistsvite7.1.2 and@vitejs/plugin-vue6.0.1 with engines^20.19.0 || >=22.12.0. If the README keeps its currentNode.js 18+prerequisite, contributors on Node 18 will fail duringnpm 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 πΒ / π.