docs: clarify current Linux release availability - #6299
Conversation
|
Thanks @mruderman — the source-vs-release clarification is scoped well. This is open as a draft, so I'll hold off on review until you mark it ready for review. |
There was a problem hiding this comment.
Pull request overview
Updates the root README to clarify that while Open Design can be run on Linux from source, current official GitHub releases do not publish a prebuilt Linux desktop artifact, and that Linux packaging/release work is still in progress (tracked in #4368).
Changes:
- Replace README claims implying a downloadable Linux AppImage with explicit guidance to run from source and a link to the Linux release tracker (#4368).
- Update the “Download the desktop app” section to avoid directing Linux users to non-existent release assets.
- Adjust the roadmap to distinguish already-published macOS/Windows desktop releases from the pending optional Linux release lane.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Hey @mruderman, thanks for marking this ready. The scope still looks consistent with the PR description: a README-only clarification of current Linux release availability. @mrcfps is already requested for the maintainer review, so the next useful step is that review pass on the current head. |
mrcfps
left a comment
There was a problem hiding this comment.
@mruderman Thank you for this focused README clarification. It accurately separates Linux source compatibility from currently published desktop artifacts. I verified the current stable release assets are macOS/Windows-only, the source-run anchor renders correctly, #4368 remains open as the Linux availability tracker, and the changed Markdown has no whitespace errors. This gives Linux users a clear and honest path forward. 🙏
🔁 Powered by Looper · runner=reviewer · agent=codex · An autonomous AI dev team for your GitHub repos.
Refs #4368 and #6190. Related: #2736, #6145, and #6146.
Why
Following the README's Linux desktop download path currently leads to the official releases page, but the latest stable release (
open-design-v0.16.1) does not publish a Linux artifact. The README also describes the Linux AppImage as both available on an optional release lane and completed in the roadmap, which makes the intended packaging support look currently downloadable.This documentation-only change distinguishes source compatibility from published distribution: Linux users can run Open Design from source today, while prebuilt Linux release work remains in progress. That gives the maintainers time to finish and validate the AppImage/Flatpak/release work without directing users to an artifact that is not there.
The public download page contains the same stale release-artifact claim; this PR deliberately keeps scope to
README.mdso that surface can be corrected independently.What users will see
Linux users will see that no prebuilt Linux artifact is currently available in the official releases, a direct link to the existing source-run instructions, and a link to the central Linux release tracker. The roadmap now separates the published macOS/Windows desktop releases from the pending optional Linux release lane.
Surface area
apps/weborapps/desktop(including Electron menu bar)odsubcommand or flag, newtools-dev/tools-packflag, or newOD_*env var/api/*endpoint, new SSE event, or changed shape inpackages/contractsskills/,design-systems/,design-templates/, orcraft/, or change to the skills protocolTRANSLATIONS.mdfor the locale workflow)package.json(dependenciesordevDependencies); workspace-packagepackage.jsonfiles are out of scope. Include a paragraph on what we get vs. what bytes we ship (seeCONTRIBUTING.md→ Code style)Screenshots
N/A — README-only documentation change.
Bug fix verification
N/A — this corrects documentation rather than executable behavior. I checked the current stable release assets and the active Linux packaging/release threads cited above.
Validation
mainand modifies onlyREADME.md(4 additions, 3 deletions).