Skip to content

docs(readme): point desktop readers at block/buzz-app and describe where each client lives - #9493

Merged
matt2e merged 3 commits into
mainfrom
link-to-buzz-app
Nov 14, 2026
Merged

matt2e merged 3 commits into
mainfrom
link-to-buzz-app

Conversation

@matt2e

@matt2e matt2e commented Nov 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Points README readers at block/buzz-app for the desktop app and describes this repo as the home of the relay and the mobile client.

  • Replaces the "Buzz 1.0 is at buzz-app" callout with a "Where to find things" table listing the desktop app, mobile client, and relay with their homes.
  • Drops the packaged desktop-build download table, the BUZZ_RELAY_URL launch note, and the "I work at Block" internal-build section; "I just want to try the app" now links to buzz-app.
  • Adds an "I want to work on the mobile app" path linking to mobile/README.md.
  • Reframes Quick start around the relay (just relay instead of just dev) and updates the common dev commands and architecture diagram so they no longer assume the desktop app lives here.

Documentation-only change; no code touched.

🤖 Generated with Claude Code

matt2e and others added 3 commits November 13, 2026 17:35
The desktop app now lives in block/buzz-app, while the mobile client and
the relay stay in this repo. The top-level README still read as the
desktop app's home: it led with desktop downloads and `just dev`.

What I found before writing: `desktop/` still exists here (about 3,450
tracked files, last touched 2026-11-12). Its own README and
CONTRIBUTING.md call it the deprecated Buzz 0.X desktop app, kept for
0.X bug fixes. So the README does not say the code is gone. It names
block/buzz-app as the desktop app's home and describes `desktop/` as
leftover 0.X code. The mobile client is in `mobile/` and the relay's
entry point is `crates/buzz-relay/`; both links were checked against
the tree.

Added
- "Where to find things" at the top: a table mapping desktop app to
  block/buzz-app, mobile client to `mobile/`, relay to
  `crates/buzz-relay/`. It replaces the old note that called this whole
  repository "Buzz 0.X".
- "I want to work on the mobile app" under Getting started, pointing at
  mobile/README.md.

Removed (desktop-only)
- "I just want to try the app": the packaged-build table, the Apple
  Silicon vs Intel hint, the Windows SmartScreen note, and the
  `BUZZ_RELAY_URL` launch instructions. A pointer to block/buzz-app
  takes their place.
- "I work at Block": the internal desktop build download.
- Quick start: `just dev`, "Desktop app pops up", and the split-terminal
  `just desktop-dev` workflow.
- Common dev commands: `just dev`.

Rewritten
- The top note: it now describes `desktop/` as deprecated 0.X code that
  takes bug fixes only, using the wording of desktop/README.md, instead
  of "still available and supported". The plugin-preview sentence is
  kept.
- "I want to build & run from source" is now "I want to run the relay
  from source".
- Quick start says up front that it stands up the relay, and its daily
  command is `just relay`. The relay hint that sat in the desktop
  section ("if you don't have a relay yet") moved into the buzz-app
  pointer.
- Status table: "Desktop app (Tauri + React)" now links block/buzz-app.
- Architecture: the diagram's human client reads "(desktop, mobile)",
  and the text below names where each client lives.
- Common dev commands: `just setup` and `just check` comments no longer
  describe them in desktop terms, and `just mobile-dev` is listed.

Left as is
- Prerequisites (Docker, Hermit, Rust, Node, pnpm): `just relay` runs
  `just bootstrap`, which still checks node and pnpm.
- "Windows prerequisites": `BUZZ_SHELL` is read by buzz-dev-mcp and
  buzz-agent in this repo, not by the desktop app.
- Product screenshots and the Releasing link. The README has no table
  of contents or badges, and nothing else in the repo links to the
  anchors that changed.

Follow-ups noticed, not changed here
- Justfile: `just dev`, the `desktop-*` recipes, `release-desktop`, and
  `check`/`ci` still build and test `desktop/`; the `setup` comment
  says "install desktop deps".
- scripts/dev-setup.sh installs desktop dependencies and prints
  "just dev  # start the desktop app" as a next step.
- CONTRIBUTING.md: "Running the Relay and Desktop App" (`just dev`,
  `just desktop-dev`), the Node/pnpm rows "required for desktop app
  commands", the Linux desktop system libraries, and the dev desktop
  state notes.
- RELEASING.md documents a Desktop release lane
  (`just release-desktop`) and never mentions block/buzz-app. The
  block/buzz Releases page still serves "Buzz Desktop v0.5.x" builds.
- AGENTS.md: desktop E2E, PR screenshot, and "Desktop App" sections.
- TESTING.md, ARCHITECTURE.md, SECURITY.md ("Desktop Secret Storage"),
  CONTEXT.md, VISION.md, docs/linux-rendering-troubleshooting.md,
  docs/admin/README.md, docs/buzz-shared-compute-dev.md,
  crates/buzz-acp/README.md, crates/buzz-cli/README.md, and
  examples/README.md mention the desktop app with no pointer to
  block/buzz-app.
- .github/workflows: `_ci-desktop.yml`, `_ci-desktop-macos.yml`,
  `desktop-release-candidate.yml`, `desktop-release-cache-proof.yml`,
  and `promote-oss-desktop-release.yml` still build and release
  `desktop/`.

Co-Authored-By: Claude Fable 5.2 <[email protected]>
Signed-off-by: Matt Toohey <[email protected]>
Review on 680dd34 asked to remove the callout describing desktop/
as the deprecated Buzz 0.X app. The "Where to find things" table
above it already points desktop work at block/buzz-app, so the note
only repeated that.

Co-Authored-By: Claude Fable 5.1 <[email protected]>
Signed-off-by: Matt Toohey <[email protected]>
Review on 8bb2d8e asked for the repository map to sit lower on the
page. The table now follows the "Stuff you do in Buzz" bullets, in its
own section separated by the same rule as its neighbours, instead of
leading the README above the screenshot.

Co-Authored-By: Claude Fable 5.1 <[email protected]>
Signed-off-by: Matt Toohey <[email protected]>
@matt2e
matt2e requested a review from a team as a code owner November 14, 2026 00:39
@matt2e
matt2e deployed to codex-review November 14, 2026 00:39 — with GitHub Actions Active
@github-actions github-actions Bot added the codex-security-review-current The posted Codex security review matches its recorded range. label Nov 14, 2026
@github-actions

Copy link
Copy Markdown

🔐 Codex Security Review

Note: This is an automated, security-focused review generated by Codex.
Use it as a supplement to human review; false positives are possible.

Scope

  • Exact PR diff: abca3cd2abeeb062eb108fb6040d031b97de1551...ed9c2d5f2d925fc2f19cd864b024ee027a1e8c1e
  • Model: gpt-6.1-sol

💡 Click "edited" above to see earlier reviews for this PR.


Review Summary

Overall Risk: NONE

The authorized PR range changes only README documentation. No concrete security, correctness, or reliability findings were identified in the changed hunks.

Findings

No concrete security, correctness, or reliability findings were identified.

Notes

  • No additional limitations were reported.

Generated by Codex Security Review |
Requested by: @matt2e |
Workflow run

@matt2e
matt2e merged commit ff030e1 into main Nov 14, 2026
42 checks passed
@matt2e
matt2e deleted the link-to-buzz-app branch November 14, 2026 00:47
wpfleger96 added a commit that referenced this pull request Nov 14, 2026
* origin/main: (24 commits)
  docs(readme): point desktop readers at block/buzz-app and describe where each client lives (#9493)
  test(cli,db): freeze the assertion test clock and give pool release tests a test-lane acquire budget (#9442)
  test(desktop): unmount every TerminalSubstrate tree before the window closes (#9440)
  fix(mobile): drop the iOS share extension from the build until it's signed (#9489)
  chore(release): release Buzz Desktop version 0.5.30 (#9491)
  perf(mobile): parse each event's thread reference once (#9460)
  perf(mobile): load only the directory when search opens (#9466)
  perf(mobile): stop rebuilding Home's channel list when a route covers it (#9459)
  perf(mobile): ask typing subscriptions only for the typing window (#9454)
  perf(mobile): skip avatar URL parsing for non-HTTP URLs (#9448)
  perf(mobile): download the identity archive list only when it changed (#9445)
  perf(mobile): don't treat a Control Center pull as a resume (#9443)
  fix(mobile): keep a superseded roster read out of the offline snapshot (#9452)
  perf(mobile): read channel bot roles from the member list (#9451)
  perf(mobile): read Activity once per reconnect (#9455)
  fix(mobile): offer role controls for agents (#9475)
  perf(mobile): stop rebuilding the native nav bar on every scrolled frame (#9458)
  perf(mobile): keep verified-name batches open as people are added (#9450)
  perf(mobile): read only changed custom emoji sets on reconnect (#9446)
  perf(mobile): keep latest-message times on a directory load (#9457)
  ...

Signed-off-by: Will Pfleger <[email protected]>

# Conflicts:
#	crates/buzz-cli/src/desktop_provider.rs
bostonaholic added a commit that referenced this pull request Nov 14, 2026
…eaction-recipients

* origin/main: (111 commits)
  perf(acp): avoid repeated observer batch serialization (#9483)
  docs(readme): point desktop readers at block/buzz-app and describe where each client lives (#9493)
  test(cli,db): freeze the assertion test clock and give pool release tests a test-lane acquire budget (#9442)
  test(desktop): unmount every TerminalSubstrate tree before the window closes (#9440)
  fix(mobile): drop the iOS share extension from the build until it's signed (#9489)
  chore(release): release Buzz Desktop version 0.5.30 (#9491)
  perf(mobile): parse each event's thread reference once (#9460)
  perf(mobile): load only the directory when search opens (#9466)
  perf(mobile): stop rebuilding Home's channel list when a route covers it (#9459)
  perf(mobile): ask typing subscriptions only for the typing window (#9454)
  perf(mobile): skip avatar URL parsing for non-HTTP URLs (#9448)
  perf(mobile): download the identity archive list only when it changed (#9445)
  perf(mobile): don't treat a Control Center pull as a resume (#9443)
  fix(mobile): keep a superseded roster read out of the offline snapshot (#9452)
  perf(mobile): read channel bot roles from the member list (#9451)
  perf(mobile): read Activity once per reconnect (#9455)
  fix(mobile): offer role controls for agents (#9475)
  perf(mobile): stop rebuilding the native nav bar on every scrolled frame (#9458)
  perf(mobile): keep verified-name batches open as people are added (#9450)
  perf(mobile): read only changed custom emoji sets on reconnect (#9446)
  ...

Signed-off-by: Matthew Boston <[email protected]>

This branch was successfully deployed

1 active deployment
codex-review — ed9c2d5f Deployed Nov 14, 2026 by matt2e via Run Codex Security Review #15131
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

codex-security-review-current The posted Codex security review matches its recorded range.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants