Skip to content

docs(readme): fix contradictory just dev command description - #5244

Open
BradGroux wants to merge 1 commit into
block:mainfrom
BradGroux:docs/readme-just-dev-description
Open

docs(readme): fix contradictory just dev command description#5244
BradGroux wants to merge 1 commit into
block:mainfrom
BradGroux:docs/readme-just-dev-description

Conversation

@BradGroux

Copy link
Copy Markdown
Contributor

What was wrong

The README had two contradictory descriptions of just dev:

  • Quick start (line 171): just dev # starts the relay + desktop app together
  • Common dev commands (line 262): just dev # Run the desktop app

A contributor following the Quick start section expects just dev to 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 for just relay separately — duplicating work or causing a port conflict.

The justfile confirms the Quick start section is correct: the dev recipe builds buzz-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:

just dev            # Run the relay + desktop app together

Also added just desktop-dev to 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 dev recipe in justfile launches both relay and desktop, and the desktop-dev recipe launches only the Vite frontend.

Closes #5160.

@BradGroux
BradGroux requested a review from a team as a code owner August 7, 2026 21:12
@jemiahw jemiahw added triage-ready Appropriate for agentic review risk:low Low risk requests documentation Improvements or additions to documentation labels Aug 7, 2026
@BradGroux
BradGroux force-pushed the docs/readme-just-dev-description branch from ecdaa18 to c49b1f8 Compare August 8, 2026 12:47
@BradGroux

Copy link
Copy Markdown
Contributor Author

This is the third recurring review + rebase pass for the open BradGroux PRs on block/buzz.

What this PR does

Fixes a contradictory description in the README for the just dev command. The old text said "Run the desktop app" but just dev actually runs both the relay and desktop app together. The fix corrects the description and adds a new entry for just desktop-dev which runs the desktop frontend only (connecting to an existing relay).

Correctness

  • The descriptions now accurately reflect what each just recipe does.
  • The new just desktop-dev entry fills a documentation gap — the recipe exists but wasn't listed in the README quick reference.
  • Minimal docs-only change, no code or behavior impact.

Rebase result

Already based on current main (02f640bc4). No rebase needed — 0 commits behind.

  • Head SHA: c49b1f8d2c99f7000fb35718e90d78fff57f215e (unchanged)
  • Mergeable: ✅ MERGEABLE
  • CI: DCO ✅, Semgrep OSS ✅, zizmor ✅

No code changes were made — this was a review + rebase pass only.

@BradGroux
BradGroux force-pushed the docs/readme-just-dev-description branch from c49b1f8 to 360f9ea Compare August 9, 2026 10:40
@BradGroux

Copy link
Copy Markdown
Contributor Author

Portfolio review update (2026-08-09)

I checked the README instructions against the current Justfile and current main. The documentation correction is still needed and accurately describes the available development command; no newer documentation change supersedes it.

I rebased the branch onto 5bf78671f45178f8de02ba18d3d321cbbf19cd1f. The documentation patch is equivalent after the rebase, merges cleanly, and upstream checks are rerunning on the rewritten head.

@BradGroux
BradGroux force-pushed the docs/readme-just-dev-description branch from 360f9ea to ffde3ad Compare August 11, 2026 03:00
@BradGroux

Copy link
Copy Markdown
Contributor Author

Portfolio rebase and review update (2026-08-11)

Rebased onto main at 7e6e9c547 (2026-08-10). No conflicts.

Still needed: The README still has contradictory just dev descriptions. The Justfile confirms just dev launches relay + desktop together, and just desktop-dev runs the frontend only against an existing relay. The PR's correction accurately describes both commands.

Verification: cargo check not applicable (docs-only). Confirmed desktop-dev recipe exists in the Justfile at line 602.

@BradGroux
BradGroux force-pushed the docs/readme-just-dev-description branch from ffde3ad to 1bf2e90 Compare August 12, 2026 02:54
@BradGroux

Copy link
Copy Markdown
Contributor Author

Rebased onto latest main (4b35706, the 0.5.10 release). No conflicts — the README just dev descriptions are still contradictory.

Reviewed for accuracy and continued relevance:

  • The contradiction between the quick-start and the recipe list descriptions of just dev is still present in main.
  • The fix aligns both descriptions to match the actual just dev recipe behavior.

The PR is mergeable and ready for review.

@BradGroux
BradGroux force-pushed the docs/readme-just-dev-description branch from 1bf2e90 to 6fccf12 Compare August 13, 2026 05:13
@BradGroux

Copy link
Copy Markdown
Contributor Author

Portfolio rebase and review update (2026-08-13)

Rebased onto main at a96af8952 (2026-08-13). No conflicts.

Still needed

Yes. The just dev command description fix is not superseded. No recent main commit touches the justfile or the README's just dev documentation.

Verification

Docs-only change. All 14 portfolio PRs confirmed MERGEABLE on GitHub.

@BradGroux
BradGroux force-pushed the docs/readme-just-dev-description branch from 6fccf12 to 25a0bc3 Compare August 15, 2026 03:01
@BradGroux

Copy link
Copy Markdown
Contributor Author

Rebase review — 2026-08-15

Rebased onto current main at 82f7ed153 (2026-08-15). 41 new commits landed since the last review point (a96af8952, 2026-08-13). This PR rebased cleanly with no conflicts.

Still-needed assessment

Checked all 41 new commits for overlap. None supersede this PR. The PR remains the correct fix for its subject area.

Verification

  • cargo check not required — no Rust conflicts
  • GitHub confirms MERGEABLE status

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>
@BradGroux
BradGroux force-pushed the docs/readme-just-dev-description branch from 25a0bc3 to 382c467 Compare August 16, 2026 07:47
@BradGroux

Copy link
Copy Markdown
Contributor Author

Rebased onto main at d8281b9 (2026-08-15). No conflicts — the branch rebased cleanly.

Three commits landed on main since the last rebase point (82f7ed1):

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: tsc --noEmit passes. GitHub confirms MERGEABLE.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation risk:low Low risk requests triage-ready Appropriate for agentic review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Contradictory definitions of the just dev command in README.md

2 participants