Skip to content

docs: align the download guide with published packages - #2297

Open
MMexicann wants to merge 1 commit into
storytold:mainfrom
MMexicann:patch-27
Open

MMexicann wants to merge 1 commit into
storytold:mainfrom
MMexicann:patch-27

Conversation

@MMexicann

@MMexicann MMexicann commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

List the current Arch Linux, RISC-V, and FreeBSD ARM64 packages. Point 32-bit Windows users to v0.16.0, the last release with both an x86 MSI and portable ZIP. Link the earlier Linux paragraph to the download table so it stays in sync.

Verification

Checked the filenames against the v0.18.1 assets, the v0.16.0 assets, and the subsequent release lists for Windows x86 availability.

Summary by CodeRabbit

  • Documentation
    • Updated download guidance to direct Linux users to the Linux download table.
    • Added Arch package options and a FreeBSD aarch64 build to the download tables.
    • Clarified that v0.16.0 was the last release with 32-bit Windows builds and updated the listed RISC-V download formats.

Updated README.md to clarify available builds for various platforms, including the last x86 release for Windows and added support for Arch Linux and RISC-V packages.
@coderabbitai

coderabbitai Bot commented Nov 21, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The README links readers to the Linux download table and updates the documented Windows, Linux, and FreeBSD download artifacts.

Changes: Platform download documentation

Layer / File(s) Summary
Platform download details
README.md
The getting-started text links to the Linux download table. The Windows table removes x86 builds and identifies v0.16.0 as the last release with 32-bit builds. The Linux table adds Arch packages and lists Debian, RPM, and tarball artifacts for RISC-V. The FreeBSD table adds an aarch64 tarball.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Suggested reviewers: echelon, switch87

Merge Risk: Minimal · up to 08543

This updates the download guide to match published packages and points 32-bit Windows users to the last release that supports them. It has no runtime impact and is low risk to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "docs: align the download guide with published packages" matches the main change. The README download guide now lists current Arch Linux, RISC-V, and FreeBSD aarch64 artifacts, removes x86 W…
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.
Full details: Title check

Explanation

The title "docs: align the download guide with published packages" matches the main change. The README download guide now lists current Arch Linux, RISC-V, and FreeBSD aarch64 artifacts, removes x86 Windows builds, and points 32-bit Windows users to v0.16.0. The title is specific and concise, and it names the documentation scope without file lists or vague terms.

Finishing Touches

Generate unit tests (beta)

  • 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

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.
Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 0ccc68f and 0854327.

Files selected for processing: 1

  • README.md

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

@autocraft-bot autocraft-bot Bot added the infra Tests, CI, docs, build, packaging, tooling label Nov 21, 2026

@autocraft-bot autocraft-bot Bot 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.

AI-generated review (Claude Opus 5.5). Not a maintainer decision.

No blocking problems found (not certain).

Updates the README download tables for Linux, Windows and FreeBSD to list the Arch, RISC-V and FreeBSD ARM64 packages, and notes v0.16.0 as the last 32-bit Windows release.

  • README.md:124-125 replaces the hard-coded list of Linux formats with a link to the Linux table, so the two can no longer drift apart; the #linux anchor needs a matching Linux heading.
  • README.md:187-188 removes the x86 row and links v0.16.0 instead. This is correct only if later release builds no longer produce i686 Windows artifacts.
  • README.md:226 adds the Arch pkg.tar.zst row with the same <ver>-linux-<arch> naming as the other rows.
  • README.md:229-231 lists riscv64 deb, rpm and tar.gz and keeps the glibc 2.39+ note.
  • README.md:273 adds the FreeBSD aarch64 tarball row, in the same format as the x86_64 row.

Claims checked:

  • unverified: Lists the current Arch Linux packages (x86_64 and aarch64 pkg.tar.zst) (README.md:226 adds the row; the release workflow that would produce these files under .github/workflows could not be read)
  • unverified: Lists the RISC-V deb, rpm and tar.gz packages (README.md:229-231 lists the three files; the riscv64 packaging job under .github/workflows could not be read)
  • unverified: Lists the FreeBSD ARM64 package (README.md:273 adds deckcraft--freebsd-aarch64.tar.gz; the FreeBSD build job could not be read)
  • unverified: v0.16.0 was the last release with an x86 MSI and portable ZIP (README.md:187-188 states this; the Windows target matrix in .github/workflows could not be read to confirm that i686 is gone)
  • unverified: The earlier Linux paragraph links to the download table so it stays in sync (README.md:124-125 links to #linux; I could not confirm that a matching 'Linux' heading exists in README.md)

Reviewed at 0854327.

Recommendation: merge, after a maintainer's decision.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

infra Tests, CI, docs, build, packaging, tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant