Skip to content

docs: clarify current Linux release availability - #6299

Open
mruderman wants to merge 1 commit into
nexu-io:mainfrom
mruderman:agent/clarify-linux-release-availability
Open

docs: clarify current Linux release availability#6299
mruderman wants to merge 1 commit into
nexu-io:mainfrom
mruderman:agent/clarify-linux-release-availability

Conversation

@mruderman

Copy link
Copy Markdown

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.md so 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

  • UI — new page / dialog / panel / menu item / setting / empty state in apps/web or apps/desktop (including Electron menu bar)
  • Keyboard shortcut — new or changed
  • CLI / env var — new od subcommand or flag, new tools-dev / tools-pack flag, or new OD_* env var
  • API / contract — new /api/* endpoint, new SSE event, or changed shape in packages/contracts
  • Extension point — new entry under skills/, design-systems/, design-templates/, or craft/, or change to the skills protocol
  • i18n keys — added new translation keys (see TRANSLATIONS.md for the locale workflow)
  • New top-level dependency — adding any new entry to the root package.json (dependencies or devDependencies); workspace-package package.json files are out of scope. Include a paragraph on what we get vs. what bytes we ship (see CONTRIBUTING.md → Code style)
  • Default behavior change — changes what existing users experience without opting in (default model, default setting, file/SQLite schema, auto-network on startup, auto-install)
  • None — internal refactor, docs, tests, or translation update only

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

  • Confirmed the branch is one commit ahead of current upstream main and modifies only README.md (4 additions, 3 deletions).
  • Verified the three stale Linux distribution claims were each replaced exactly once.
  • Verified the source-install anchor and issue links are present in the resulting README.
  • No code or package tests run; the change is Markdown-only.

@lefarcen

Copy link
Copy Markdown
Contributor

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.

@lefarcen
lefarcen requested a review from mrcfps July 31, 2026 05:33
@lefarcen lefarcen added size/XS PR changes <20 lines risk/low Low risk: docs/i18n/assets only type/docs Documentation changes only labels Jul 31, 2026
@mruderman
mruderman marked this pull request as ready for review July 31, 2026 08:26
Copilot AI review requested due to automatic review settings July 31, 2026 08:26

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@lefarcen

Copy link
Copy Markdown
Contributor

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 mrcfps left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

@lefarcen lefarcen mentioned this pull request Aug 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

risk/low Low risk: docs/i18n/assets only size/XS PR changes <20 lines type/docs Documentation changes only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants