Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[read the docs] Documentation not pointing to the latest release #1698

Open
3 tasks done
caizixian opened this issue Mar 8, 2024 · 0 comments
Open
3 tasks done

[read the docs] Documentation not pointing to the latest release #1698

caizixian opened this issue Mar 8, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@caizixian
Copy link
Contributor

Background Work

FireSim Version and Hash

Not applicable.

OS Setup

Not applicable.

Other Setup

Current Behavior

Both stable and latest points to the doc of 1.17.1 instead of 1.18.0. This could be misleading. For example, if you download the bitstream tar by following the link https://docs.fires.im/en/latest/Getting-Started-Guides/On-Premises-FPGA-Getting-Started/Initial-Setup/Xilinx-Alveo-U250.html#install-your-fpga-s , you will actually download the .mcs used by 1.17.1 release. If you then run firesim infrasetup on a 1.18.0 checkout (and thinking since you are browsing the doc for latest, it's indeed the doc for 1.18.0), it will flash the non-matching .bit, and there could be confusing errors.

Expected Behavior

The stable and latest doc rendering should always point to the latest tagged release to avoid confusion.

Other Information

No response

@caizixian caizixian added the bug Something isn't working label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant