Skip to content

Keybard Overlay x3: several boards, and Linux - #4

Merged
morganvenable merged 3 commits into
mainfrom
docs-x3-overlay
Oct 20, 2026
Merged

morganvenable merged 3 commits into
mainfrom
docs-x3-overlay

Conversation

@morganvenable

@morganvenable morganvenable commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Draft: for the x3 prerelease. Don't merge until x3 ships; merging publishes docs.svalboard.com.

Summary

Documents the x3 Keybard Overlay changes: following every connected Svalboard (svalboard/keybard#78) and the Linux test build (svalboard/keybard#80, from companion/overlay-host/packaging/linux/README-LINUX.md). Each new section carries an "Available from x3" note linking the x3 release. Linux problems point to GitHub issues on svalboard/keybard, with the --diagnose report attached.

Pages changed

  • Keybard (keybard/index.mdx), Desktop overlay:
    • New Install it on Linux: requirements (glibc 2.34+), AppImage or tarball, the udev rule script, starting it, the app menu entry; Wayland, tray icons and other limits (XWayland by default, the GNOME AppIndicator extension, the compositor, missing libraries, the port); Check what the overlay sees (--diagnose, the log, removing it).
    • New Several Svalboards at once: Follow the board in use, one board only, Disconnect, blank-keymap boards, reconnect after a firmware update.
    • Overlay settings: the Board item and the new Pointing devices menu.
    • Connect it to Keybard: a screenshot of the Desktop overlay dialog.
    • Other platforms: Linux now links to the new section.

No sidebar changes.

Screenshots

Real capture of Keybard at svalboard/keybard main eab5db1, at 2x in light theme:

Desktop overlay dialog

The Overlay app's own menus aren't pictured.

Note for svalboard/keybard

The page gives Fedora 35 as the Linux minimum: Fedora 35 ships glibc 2.34, matching the Overlay release notes. companion/overlay-host/packaging/linux/README-LINUX.md says Fedora 36+ and needs the same fix in svalboard/keybard.

Checks

npm run check: wording ok. npm run build: all internal links valid.

🤖 Generated with Claude Code

https://claude.ai/code/session_012ePhiApV6LQcH1sdfSp2aR

morganvenable and others added 3 commits October 19, 2026 12:51
Adds following several Svalboards at once, the Board and Pointing devices
menus, and the Linux test build: packages, the udev rule, limits and
--diagnose. Each section is marked Available from x3.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012ePhiApV6LQcH1sdfSp2aR
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012ePhiApV6LQcH1sdfSp2aR
The x3 notes now link each repo's releases page instead of the x3 tag,
and state the requirement as x3 or later.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012ePhiApV6LQcH1sdfSp2aR
@morganvenable
morganvenable marked this pull request as ready for review October 20, 2026 15:09
@morganvenable
morganvenable merged commit ed22d65 into main Oct 20, 2026
2 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