docs: refresh the roadmap, trim the cross-platform guide, and update the Linux setup and desktop guides - #1601
Merged
Merged
Conversation
…the Linux setup and desktop guides The roadmap still listed Windows work (UIA tree depth, monitor_select) and "fail loudly on unsupported capabilities" as open, all of which shipped. It now records that Linux and Windows parity is complete, that proving both in use is the near-term work, and points at the open enhancement issues and COSMIC/GNOME state instead of a stale feature list. The cross-platform guide drops a fifth of its length: footnotes that had grown into essays are cut to the facts they own, repeated ADR justifications go, the duplicated footnote 7 is renumbered, and the accessibility file table names files that exist. Every heading other docs and code link to is kept, and the generated platform-support table is untouched. The Linux setup and desktop guides now describe the lifetime keyboard proxy consistently, list Wayfire and the wayland-other refusal in the backend tables, quote the daemon's real error strings in troubleshooting, and name wayland-info rather than wl-info.
Contributor
Greptile SummaryRefreshes the platform documentation to match current Linux and Windows support.
Confidence Score: 5/5The documentation-only PR appears safe to merge with no outstanding actionable findings. The previously reported KDE fallback problem is fully fixed by distinguishing wlroots virtual-pointer fallback from KDE's libei portal fallback, and the additional KDE uinput descriptions agree with the current routing behavior.
|
| Filename | Overview |
|---|---|
| docs/CROSS_PLATFORM.md | Condenses the cross-platform reference and accurately clarifies KDE's uinput and libei scroll paths. |
| docs/LINUX_SETUP.md | Updates backend, permission, setup, and troubleshooting guidance, including a complete fix for the prior KDE fallback wording. |
| docs/LINUX_DESKTOPS.md | Refreshes KDE, wlroots, Wayfire, hotkey, and unsupported-compositor guidance. |
| docs/ROADMAP.md | Replaces completed parity work with current reliability priorities and prospective platform directions. |
Reviews (2): Last reviewed commit: "docs(linux): name libei as the KDE scrol..." | Re-trigger Greptile
…ointer KDE tries the uinput wheel first like wlroots does, but when /dev/uinput is unwritable the rest of the scroll goes out on libei through the RemoteDesktop session, not on a virtual pointer KWin does not implement. The setup note and the capability matrix said otherwise.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR refreshes the four platform docs that had drifted from the tree. The roadmap still listed Windows work that shipped in the last release (full UIA tree walk,
monitor_select) and "make unsupported capabilities fail loudly" as open. It now records that Linux and Windows parity is complete, that the near-term work is proving both in use under the six-clean-releases rule, and points at the open enhancement issues and the COSMIC and GNOME state rather than a stale feature list.The cross-platform guide loses about a fifth of its length. Footnotes that had grown into essays are cut back to the facts they own, repeated ADR justifications are dropped, the footnote numbered 7 twice is renumbered, and the accessibility file table names files that exist. Every heading that other docs, skills and code comments link to is kept, and the generated platform-support table is byte-identical.
The Linux setup and desktop guides now describe the lifetime keyboard proxy from #1600 consistently, list Wayfire and the
wayland-otherrefusal in the backend tables, quote the daemon's real error strings under troubleshooting, and namewayland-infoinstead of the nonexistentwl-info.Related Issues
None.
Target Platform
Type of Change
feat— New featurefix— Bug fixrefactor— Code restructuring (no behavior change)perf— Performance improvementdocs— Documentation onlytest— Adding or updating testschore— Build, CI, dependencies, toolingCross-Platform Checklist
//go:build darwin) — N/A, docs onlyCodeNotSupported) — N/A, docs onlyGeneral Checklist
just fmt)just cipasses — N/A, docs-only fast path:just fmt-check && just lintexit 0, plusgo test ./internal/architecture/for the doc-link, guide-citation and platform-support guardrailssubject written for users — this PR squash-merges, so the title is what
Release Please ships in the changelog, not the commits on the branch
Additional Context
Every quoted log and error string in the two Linux guides was grepped against the tree, and every anchor into the four files from the rest of the repo was checked against the new headings. Two neighbouring docs still carry the same drift and are left for a follow-up: the README platform table shows Windows without Vision OCR or
monitor_select, anddocs/CONFIGURATION.mdsays the vision strategy is unavailable on Windows.