docs(linux): add arch linux setup and build instructions#2343
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughThis PR updates contributor docs to add structured project overview and expanded Linux setup instructions (Arch and Ubuntu/Debian) across the beginner guide, Rust core build guide, and an Arch quick-start, including package install commands, toolchain setup, and verification steps. ChangesLinux Setup Documentation Expansion
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment |
graycyrus
left a comment
There was a problem hiding this comment.
Nice contribution — Arch Linux coverage in the onboarding docs is a real gap, and the package mappings are solid. Two minor nits, neither blocking:
[minor] gitbooks/developing/getting-set-up.md — The Arch quick-start command is missing openssl. Both CONTRIBUTING-BEGINNERS.md and building-rust-core.md include it in the core-only deps (needed by networking crates). Add it so someone following only this guide doesn't hit a build failure:
sudo pacman -S --needed nodejs npm rustup cmake base-devel clang openssl \
alsa-lib xdotool ...[minor] gitbooks/developing/building-rust-core.md — The "Why these matter" section maps libudev-dev → libevdev, but these are different libraries (libudev = systemd device management, libevdev = evdev input). On Arch, libudev ships via systemd-libs (installed by default) so it doesn't need listing. libevdev is a separate input library that is needed. The install commands are correct — just this description line is slightly misleading. Suggestion:
- … libxdo-dev / xdotool, libudev-dev (included in Arch systemd-libs), libevdev: required by …
|
review requested to the maintainers of this project : ) |
Summary
CONTRIBUTING-BEGINNERS.mddetailing packages for both core-only builds and desktop shell builds.gitbooks/developing/building-rust-core.mdwith explicit Archpacmandependency maps alongside the existing Debian/Ubuntu instructions.gitbooks/developing/getting-set-up.md.Problem
libxdo,libxi,webkit2gtk-4.1, andlibayatana-appindicator.Solution
pacmanequivalents, grouping them clearly into base-build tools and desktop/CEF shell dependencies.-devpackages are not needed and why the manuallibstdc++.sopath symlink workaround for clang/whisper-rs is typically unnecessary.Submission Checklist
diff-cover) meet the gate enforced by.github/workflows/coverage.yml. Runpnpm test:coverageandpnpm test:rustlocally; PRs below 80% on changed lines will not merge. (N/A: Documentation-only change)docs/TEST-COVERAGE-MATRIX.mdreflect this change (orN/A: behaviour-only change) (N/A: Documentation-only change)## Related(N/A: Documentation-only change)docs/RELEASE-MANUAL-SMOKE.md) (N/A: Documentation-only change)Closes #NNNin the## Relatedsection (N/A: No corresponding GitHub Issue exists)Impact
Related
AI Authored PR Metadata (required for Codex/Linear PRs)
Linear Issue
Commit & Branch
Validation Run
pnpm --filter openhuman-app format:check(Verified formatting locally via Prettier)pnpm typecheckBehavior Changes
Parity Contract
Duplicate / Superseded PR Handling
Summary by CodeRabbit