Skip to content

docs: recommend the udev rule wherever Wayland clicks are mentioned - #1102

Merged
EtienneLescot merged 2 commits into
mainfrom
docs/udev-rule-everywhere
Oct 10, 2026
Merged

EtienneLescot merged 2 commits into
mainfrom
docs/udev-rule-everywhere

Conversation

@EtienneLescot

@EtienneLescot EtienneLescot commented Oct 10, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

The install page recommends a udev uaccess rule for pointer devices and keeps the input group as a fallback. Every other page still said the group was required. They now name both, udev first, and link to the install section instead of copying the rule.

  • English: README.md, electron/native/README.md, Recording, the product demo guide, and the Linux, auto-zoom and Loom pages.
  • Translations: the same pages in all 7 locales, in a second commit.
  • The Linux page also takes the install page's keystroke wording ("ignores every other event") in place of "reads only the left button".

Related issue

Refs #1099

Type of change

  • Bug fix
  • Feature
  • Enhancement
  • Documentation
  • Refactor / maintenance
  • Performance
  • Security

Release impact

  • Patch
  • Minor
  • Major / breaking change
  • No release note needed

Desktop impact

  • Windows
  • macOS
  • Linux
  • Installer / packaging
  • Not platform-specific

Screenshots / video

N/A, text only.

Testing

  • npm run docs:check passes.
  • git grep shows no page outside the install page that names the input group without the udev rule.
  • The website build and i18n check run in the Docs workflow.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated Linux guidance to explain that Wayland click capture needs mouse read access, available through a recommended udev rule or input group membership.
    • Clarified that the udev option limits access to pointer devices, while the input group provides broader access to input devices.
    • Documented that recording continues without this access, but cursor samples are recorded as movement rather than clicks.

The install page now recommends a udev uaccess rule for pointer devices and keeps the input group as a fallback. README, the native README, Recording, the product demo guide and the Linux, auto-zoom and Loom pages still said the group was required; they now name both and link to the install section.
@coderabbitai

coderabbitai Bot commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d55ff7b8-8dff-4a41-8166-aea097de0b32

📥 Commits

Reviewing files that changed from the base of the PR and between 2cf82d6 and 1f4049f.


📒 Files selected for processing (42)
  • README.md
  • electron/native/README.md
  • website/docs/guides/product-demo-video.md
  • website/docs/recording.md
  • website/i18n/de/docusaurus-plugin-content-docs/current/guides/product-demo-video.md
  • website/i18n/de/docusaurus-plugin-content-docs/current/recording.md
  • website/i18n/de/docusaurus-plugin-content-pages/alternatives/loom.mdx
  • website/i18n/de/docusaurus-plugin-content-pages/features/auto-zoom.mdx
  • website/i18n/de/docusaurus-plugin-content-pages/screen-recorder-linux.mdx
  • website/i18n/es/docusaurus-plugin-content-docs/current/guides/product-demo-video.md
  • website/i18n/es/docusaurus-plugin-content-docs/current/recording.md
  • website/i18n/es/docusaurus-plugin-content-pages/alternatives/loom.mdx
  • website/i18n/es/docusaurus-plugin-content-pages/features/auto-zoom.mdx
  • website/i18n/es/docusaurus-plugin-content-pages/screen-recorder-linux.mdx
  • website/i18n/fr/docusaurus-plugin-content-docs/current/guides/product-demo-video.md
  • website/i18n/fr/docusaurus-plugin-content-docs/current/recording.md
  • website/i18n/fr/docusaurus-plugin-content-pages/alternatives/loom.mdx
  • website/i18n/fr/docusaurus-plugin-content-pages/features/auto-zoom.mdx
  • website/i18n/fr/docusaurus-plugin-content-pages/screen-recorder-linux.mdx
  • website/i18n/ja/docusaurus-plugin-content-docs/current/guides/product-demo-video.md
  • website/i18n/ja/docusaurus-plugin-content-docs/current/recording.md
  • website/i18n/ja/docusaurus-plugin-content-pages/alternatives/loom.mdx
  • website/i18n/ja/docusaurus-plugin-content-pages/features/auto-zoom.mdx
  • website/i18n/ja/docusaurus-plugin-content-pages/screen-recorder-linux.mdx
  • website/i18n/pt-BR/docusaurus-plugin-content-docs/current/guides/product-demo-video.md
  • website/i18n/pt-BR/docusaurus-plugin-content-docs/current/recording.md
  • website/i18n/pt-BR/docusaurus-plugin-content-pages/alternatives/loom.mdx
  • website/i18n/pt-BR/docusaurus-plugin-content-pages/features/auto-zoom.mdx
  • website/i18n/pt-BR/docusaurus-plugin-content-pages/screen-recorder-linux.mdx
  • website/i18n/zh-CN/docusaurus-plugin-content-docs/current/guides/product-demo-video.md
  • website/i18n/zh-CN/docusaurus-plugin-content-docs/current/recording.md
  • website/i18n/zh-CN/docusaurus-plugin-content-pages/alternatives/loom.mdx
  • website/i18n/zh-CN/docusaurus-plugin-content-pages/features/auto-zoom.mdx
  • website/i18n/zh-CN/docusaurus-plugin-content-pages/screen-recorder-linux.mdx
  • website/i18n/zh-TW/docusaurus-plugin-content-docs/current/guides/product-demo-video.md
  • website/i18n/zh-TW/docusaurus-plugin-content-docs/current/recording.md
  • website/i18n/zh-TW/docusaurus-plugin-content-pages/alternatives/loom.mdx
  • website/i18n/zh-TW/docusaurus-plugin-content-pages/features/auto-zoom.mdx
  • website/i18n/zh-TW/docusaurus-plugin-content-pages/screen-recorder-linux.mdx
  • website/src/pages/alternatives/loom.mdx
  • website/src/pages/features/auto-zoom.mdx
  • website/src/pages/screen-recorder-linux.mdx

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.



📝 Walkthrough

Walkthrough

The Linux click-capture documentation now describes mouse-read access through a udev rule or input group membership. Recorder pages also clarify capture scope and behavior when neither access option is configured. The updates appear in the primary English documentation and its localized versions.

Changes

Linux click-capture access

Layer / File(s) Summary
Recorder behavior and setup
README.md, electron/native/README.md, website/src/pages/screen-recorder-linux.mdx, website/i18n/*/docusaurus-plugin-content-pages/screen-recorder-linux.mdx
The Linux recorder documentation describes udev rules and input group membership as access options. It documents left-button capture and movement-only cursor samples when mouse access is unavailable.
Related recording and feature guidance
website/docs/*, website/src/pages/alternatives/loom.mdx, website/src/pages/features/auto-zoom.mdx, website/i18n/*/docusaurus-plugin-content-docs/current/*, website/i18n/*/docusaurus-plugin-content-pages/alternatives/loom.mdx, website/i18n/*/docusaurus-plugin-content-pages/features/auto-zoom.mdx
Recording guides and feature descriptions replace the group-only requirement with mouse-read access via udev or the input group.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Other


Merge Risk: ⚪ Minimal · up to 1f404

The documentation adds a narrower udev setup alongside the broader input-group option. No material merge risk is evident.

Pre-merge checks | Passed 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check Passed The title clearly identifies the main documentation change: recommending a udev rule wherever Wayland click guidance appears.
Description check Passed The description follows the repository template and includes the summary, related issue, change type, release impact, platform impact, screenshots note, and testing details.
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…
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@EtienneLescot
EtienneLescot merged commit a3aea58 into main Oct 10, 2026
21 checks 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.

1 participant