Skip to content

docs: point pre-built binary docs to OpenROAD VaultLink - #4707

Merged
vvbandeira merged 1 commit into
The-OpenROAD-Project:masterfrom
vvbandeira:docs-prebuilt-vaultlink
Oct 20, 2026
Merged

vvbandeira merged 1 commit into
The-OpenROAD-Project:masterfrom
vvbandeira:docs-prebuilt-vaultlink

Conversation

@vvbandeira

Copy link
Copy Markdown
Member

The pre-built OpenROAD binaries from Precision Innovations moved from GitHub releases to OpenROAD VaultLink.
The GitHub releases page is frozen, and its newest entry sends readers to VaultLink.
This PR points the pre-built and Docker docs to VaultLink and keeps the Precision Innovations credit.

VaultLink has .deb packages for Ubuntu 22.04 and 24.04, so the platform list and the example file name now match those packages.
The PR also removes Debian 11 and Ubuntu 22.04 (aarch64) from the supported platform lists in the local build and WSL docs.
The dependency installer does not support Debian 11, and the KLayout tip that applied only to Debian 11 is removed.

The Precision Innovations GitHub releases page is frozen and now sends
readers to VaultLink. The pre-built packages there are for Ubuntu 22.04
and 24.04 only, and the file names have a new format.

Also remove Debian 11 and Ubuntu aarch64 from the supported platform
lists. The dependency installer does not support Debian 11.

Signed-off-by: Vitor Bandeira <vvbandeira@precisioninno.com>

@gemini-code-assist gemini-code-assist 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.

Code Review

This pull request updates the documentation to remove support for Debian 11 and Ubuntu 22.04(aarch64), transition pre-built binary links to OpenROAD VaultLink, and add support for Ubuntu 24.04. The review feedback recommends correcting the spelling of 'Rocky Linux' for consistency and updating the WSL documentation to use the term 'distribution' instead of 'kernel' for technical accuracy.

Comment thread docs/user/BuildLocally.md
The `setup.sh` script installs all of the dependencies, including OpenROAD dependencies, if they are not already installed.

Supported configurations are: Ubuntu 22.04, Ubuntu 22.04(aarch64), RHEL 8, RockyLinux 9 and Debian 11.
Supported configurations are: Ubuntu 22.04, RHEL 8 and RockyLinux 9.

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.

medium

Rocky Linux is officially spelled with a space. Let's update "RockyLinux 9" to "Rocky Linux 9" for consistency and correctness.

Suggested change
Supported configurations are: Ubuntu 22.04, RHEL 8 and RockyLinux 9.
Supported configurations are: Ubuntu 22.04, RHEL 8 and Rocky Linux 9.

Comment thread docs/user/BuildWithWSL.md

## Install WSL
Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any kernel supported, such as: Ubuntu 22.04, RHEL 8, RockyLinux 9, Debian 11.
Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any kernel supported, such as: Ubuntu 22.04, RHEL 8, RockyLinux 9.

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.

medium

In WSL, users install Linux distributions (or distros) rather than kernels (WSL itself runs on a single Microsoft-provided Linux kernel). Also, "Rocky Linux" should be spelled with a space for consistency.

Suggested change
Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any kernel supported, such as: Ubuntu 22.04, RHEL 8, RockyLinux 9.
Instructions to install WSL can be found [here](https://learn.microsoft.com/en-us/windows/wsl/install). You may use any distribution supported, such as: Ubuntu 22.04, RHEL 8, Rocky Linux 9.

@vvbandeira
vvbandeira merged commit 1a2d00f into The-OpenROAD-Project:master Oct 20, 2026
10 of 12 checks passed
@vvbandeira
vvbandeira deleted the docs-prebuilt-vaultlink branch October 20, 2026 21:31
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