Skip to content

Add Arch Linux installation instructions - #209

Merged
debpalash merged 2 commits into
debpalash:mainfrom
Antony-hash512:main
Jun 1, 2026
Merged

Add Arch Linux installation instructions#209
debpalash merged 2 commits into
debpalash:mainfrom
Antony-hash512:main

Conversation

@Antony-hash512

@Antony-hash512 Antony-hash512 commented May 31, 2026

Copy link
Copy Markdown
Contributor

Added installation instructions for Arch Linux.

Summary

Added the necessary pacman command to install required build dependencies for Arch Linux users. This helps to avoid linker errors (specifically missing libxdo / xdotool required for global shortcuts) when building the Tauri frontend on Arch-based distributions.

Changes

  • Updated docs/install/linux.md to include Arch Linux dependencies (base-devel, webkit2gtk-4.1, libayatana-appindicator, librsvg, openssl, xdotool).
  • Added the --needed flag to the pacman command to prevent reinstalling already up-to-date packages.

Type

  • 🐛 Bug fix
  • ✨ New feature
  • ♻️ Refactor
  • 📝 Documentation
  • 🧪 Tests
  • 🔧 CI / Build
  • 🚀 Release prep (RC or final)

Testing

  • Verified the build process locally on Arch Linux.
  • Confirmed that installing these packages successfully resolves the rust-lld: error: unable to find library -lxdo error during bun run desktop-prod.

Checklist

  • I've tested this locally
  • I've updated relevant documentation (if applicable)
  • No local machine paths, logs, or personal env details in this PR
  • Version files are in sync (if version bump): pyproject.toml, package.json, tauri.conf.json, Cargo.toml
  • If this PR changes runtime behavior, the regression fixture at tests/fixtures/omnivoice_data/ still loads green on the smoke-matrix CI job (macOS + Windows + Linux)
  • If this is part of a release, I've read the "Release cadence" section below and confirmed this PR targets the right RC

Summary by CodeRabbit

  • Documentation
    • Updated Linux installation prerequisites to add Arch Linux-specific instructions for installing GTK and WebKit runtime dependencies required by the desktop shell. This clarifies required packages and installation steps for Arch users, aligning Arch guidance with existing Debian/Ubuntu and Fedora notes to reduce setup friction and improve installation success on Arch systems.

Added installation instructions for Arch Linux.
@coderabbitai

coderabbitai Bot commented May 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: c47c6730-0bc8-48bb-a4ae-a248b5f72db5

📥 Commits

Reviewing files that changed from the base of the PR and between 8aa0829 and 6f525be.

📒 Files selected for processing (1)
  • docs/install/linux.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/install/linux.md

📝 Walkthrough

Walkthrough

Extended the Linux installation guide with Arch Linux-specific GTK/WebKit dependency installation instructions using pacman, matching the existing Debian/Ubuntu and Fedora sections.

Changes

Arch Linux installation prerequisites

Layer / File(s) Summary
Arch Linux prerequisite install command
docs/install/linux.md
Added # Arch subsection with sudo pacman -S --needed command for installing GTK/WebKit packages required for Tauri shell development.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main change—adding Arch Linux installation instructions to the documentation.
Description check ✅ Passed The description follows the template structure with populated Summary, Changes, Type, Testing, and Checklist sections, providing clear context for the documentation update.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps

greptile-apps Bot commented May 31, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds Arch Linux package installation instructions to the Linux prerequisites section of docs/install/linux.md. The packages listed correctly resolve the rust-lld: error: unable to find library -lxdo linker error reported by Arch users building the Tauri frontend.

  • Added sudo pacman -S --needed base-devel webkit2gtk-4.1 libayatana-appindicator librsvg openssl xdotool under a new # Arch comment inside the existing GTK/WebKit deps code block.
  • Package mapping is accurate: base-develbuild-essential, webkit2gtk-4.1libwebkit2gtk-4.1-dev, xdotool (which bundles libxdo.so on Arch) → libxdo-dev, and the remaining three packages mirror their Debian/Fedora counterparts correctly.
  • The --needed flag is placed in the conventional position (after -S, before package names), consistent with standard Arch Linux documentation style.

Confidence Score: 5/5

Documentation-only change; no runtime behaviour is affected and the package list is accurate.

The diff is three lines of Markdown inside a fenced code block. The Arch package names correctly map to every dependency listed for Debian/Ubuntu. On Arch, xdotool ships libxdo.so in the same package (unlike Debian's split libxdo-dev), so the mapping resolves the reported linker error. No code, configuration, or runtime behaviour is touched.

No files require special attention.

Important Files Changed

Filename Overview
docs/install/linux.md Adds 3-line Arch Linux pacman prerequisite block; package names are correct and the --needed flag is correctly positioned.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Linux user follows install guide] --> B{Which distro?}
    B -->|Debian / Ubuntu| C["sudo apt install libwebkit2gtk-4.1-dev libayatana-appindicator3-dev librsvg2-dev libssl-dev libxdo-dev build-essential"]
    B -->|Fedora| D["sudo dnf install webkit2gtk4.1-devel libappindicator-gtk3-devel librsvg2-devel openssl-devel"]
    B -->|Arch| E["sudo pacman -S --needed base-devel webkit2gtk-4.1 libayatana-appindicator librsvg openssl xdotool"]
    C --> F[bun run desktop-prod]
    D --> F
    E --> F
    F --> G[OmniVoice Studio running]
Loading

Reviews (2): Last reviewed commit: "Update docs/install/linux.md" | Re-trigger Greptile

Comment thread docs/install/linux.md Outdated
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@debpalash

Copy link
Copy Markdown
Owner

Thanks @Antony-hash512 — this is a clean fix that fills a real gap (the install doc already listed Arch in the intro but had no pacman command). The package set maps 1:1 to the existing Debian/Fedora instructions, and xdotool is exactly what resolves the -lxdo linker error for global shortcuts. Merging. 🙏

@debpalash
debpalash merged commit 506fa8e into debpalash:main Jun 1, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants