docs(readme): fix contradictory just dev command description - #5244
docs(readme): fix contradictory just dev command description#5244BradGroux wants to merge 1 commit into
Conversation
ecdaa18 to
c49b1f8
Compare
|
This is the third recurring review + rebase pass for the open BradGroux PRs on What this PR doesFixes a contradictory description in the README for the Correctness
Rebase resultAlready based on current main (
No code changes were made — this was a review + rebase pass only. |
c49b1f8 to
360f9ea
Compare
|
Portfolio review update (2026-08-09) I checked the README instructions against the current Justfile and current I rebased the branch onto |
360f9ea to
ffde3ad
Compare
|
Portfolio rebase and review update (2026-08-11) Rebased onto Still needed: The README still has contradictory Verification: |
ffde3ad to
1bf2e90
Compare
|
Rebased onto latest main (4b35706, the 0.5.10 release). No conflicts — the README Reviewed for accuracy and continued relevance:
The PR is mergeable and ready for review. |
1bf2e90 to
6fccf12
Compare
|
Portfolio rebase and review update (2026-08-13) Rebased onto Still neededYes. The VerificationDocs-only change. All 14 portfolio PRs confirmed |
6fccf12 to
25a0bc3
Compare
Rebase review — 2026-08-15Rebased onto current Still-needed assessmentChecked all 41 new commits for overlap. None supersede this PR. The PR remains the correct fix for its subject area. Verification
|
The Common dev commands section described just dev as running only the desktop app, but it actually starts both the relay and the desktop app together. Corrected the description to match the Quick start section and the justfile recipe. Also added just desktop-dev to the command list, since it is the command that runs only the desktop frontend. Closes block#5160 Co-authored-by: Brad Groux <bradgroux@users.noreply.github.com> Signed-off-by: Brad Groux <bradgroux@users.noreply.github.com>
25a0bc3 to
382c467
Compare
|
Rebased onto Three commits landed on
All three are mobile or desktop sidebar changes with no overlap with this PR's subject area. The fix is still needed — no recent commit addresses the same problem. Verification: |
What was wrong
The README had two contradictory descriptions of
just dev:just dev # starts the relay + desktop app togetherjust dev # Run the desktop appA contributor following the Quick start section expects
just devto launch both the relay and the desktop app. Someone reading only the Common dev commands table would believe it launches the desktop app alone and would reach forjust relayseparately — duplicating work or causing a port conflict.The justfile confirms the Quick start section is correct: the
devrecipe buildsbuzz-relay, starts it in the background, waits for readiness, then launches the Tauri desktop app.What changed
Corrected the Common dev commands entry to match the Quick start section and the actual recipe:
Also added
just desktop-devto the command list, since it is the actual command for running only the desktop frontend (connecting to an already-running relay). It was previously mentioned only in the Quick start section's split-terminal note, making it easy to miss.Verification
Read-only documentation change. No code, tests, or build artifacts are affected. Confirmed the
devrecipe injustfilelaunches both relay and desktop, and thedesktop-devrecipe launches only the Vite frontend.Closes #5160.