docs: fix build steps and package paths in READMEs

[danditomaso]

Summary

• Root README and apps/web/README.md still pointed at the pre-monorepo packages/web path and used the filter @meshtastic/web, which resolves to the workspace root package rather than the web app. Following the docs did not build the app.
• Buf CLI was listed as optional in Prerequisites even though pnpm -r build invokes buf generate in @meshtastic/protobufs unconditionally, so a fresh clone + pnpm -r build fails with sh: buf: command not found unless Buf is installed.
• apps/web/README.md linked its Contributing guide via packages/web/CONTRIBUTING.md (broken).

Fixes #1252.

Changes

• Root README.md: clarify that libraries live under packages/ and the reference web client under apps/; mark Buf CLI required for pnpm -r build; document topological build order; add web-only build path pnpm --filter meshtastic-web... build; fix filter name (@meshtastic/web → meshtastic-web).
• apps/web/README.md: replace cd packages/web && pnpm install with a root-level pnpm install; use pnpm --filter meshtastic-web for dev, build, and run package; fix Contributing link (packages/web → apps/web).

Test plan

• Fresh clone → pnpm install at repo root succeeds
• With Buf CLI installed → pnpm -r build succeeds
• pnpm --filter meshtastic-web dev starts the web client
• pnpm --filter meshtastic-web... build builds the web client + its workspace deps without touching every publishable package

Summary by CodeRabbit

• Documentation
  • Clarified the distinction between workspace libraries and the web client.
  • Updated setup instructions to install dependencies from the repository root.
  • Documented workspace-wide and web-client-specific build and packaging commands.
  • Added Buf CLI prerequisites and updated the web development command to meshtastic-web.
  • Corrected the contribution guidelines link.

[vercel]

@danditomaso is attempting to deploy a commit to the Meshtastic Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: eb5cb7d4-c78c-4d59-b68d-6885034be4eb

📥 Commits

Reviewing files that changed from the base of the PR and between 98d0366 and 29b11e3.

📒 Files selected for processing (1)

• README.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

---

📝 Walkthrough

Walkthrough

The README files now describe the packages/ and apps/ layout, Buf CLI prerequisites, workspace build ordering, filtered web client commands, and the corrected contribution guidelines path.

Changes

Workspace documentation

Layer / File(s)	Summary
Workspace layout and build instructions README.md	The root README documents the workspace layout, Buf CLI requirements, meshtastic-web development filtering, and full or filtered build commands.
Web client commands and contribution path apps/web/README.md	The web client README uses repository-root installation, filtered development, build, and packaging commands, and links to apps/web/CONTRIBUTING.md.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 29b11

This documentation-only change corrects build commands, package paths, and prerequisites; no actionable merge-blocking risk remains after normal checks and review.

Poem

A rabbit hops through pnpm light,
Buf stands ready for the build tonight.
meshtastic-web runs swift and clear,
Root commands guide developers near.
The right contribution path is here.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	The changes correct documentation issues but do not resolve issue #1252's reported missing packages/ui/dist/theme/default.css build failure.	Address the reported UI build failure or document why the issue's failure is outside this pull request's scope.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the README build-step and package-path corrections.
Description check	✅ Passed	The description explains the problem, related issue, changes, and test plan, although it uses headings different from the template.
Out of Scope Changes check	✅ Passed	The changes are limited to README corrections, prerequisites, build commands, workspace paths, and contribution links covered by the stated objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
web-test	Ready	Preview	Aug 23, 2026 1:07am