-
Notifications
You must be signed in to change notification settings - Fork 100
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
Allow the user to select the version of the docs #17434
base: main
Are you sure you want to change the base?
Conversation
</div> | ||
|
||
<script> | ||
const VERSIONS_URL = 'https://raw.githubusercontent.com/tenstorrent/tt-metal/refs/heads/dimitri/test-versioned-docs/docs/published_versions.json'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Don't forget to change this to main
branch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this
66933ee
to
5ace216
Compare
…tt-metal into dimitri/test-versioned-docs
See the version switching working on the staging server - https://tenstorrent-docs-test.github.io/tt-metal/v0.55.0/ttnn/index.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remember to change to main branch
not sure if intentional but there's a UI glitch here @dimitri-tenstorrent ? |
Version 132.0.6834.160 (Official Build) (arm64) |
Ticket
#17433
Problem description
The users would like to see the documentation for several past versions but we currently only build the documentation for the latest commit on main.
What's changed
The versions of the documentation are stored in https://github.com/tenstorrent/tt-metal/blob/dimitri/test-versioned-docs/docs/published_versions.json
The UI selector makes the HTTP request to get the list of the possible versions and adds the versions to the list for the user to select.
This required a change to the _layout.html for both
ttnn
andtt-metalium
.The deployment of Github pages (what we currently use to host documentation) needs to change to be done from the branch
gh-pages
. This is needed so that we store previous documentation and only add new versions to the branch as folders.The proposed folder structure (e.g.):
We will need to change the settings for Github pages to be similar to the image below:
Additional Requirements
Checklist
gh-pages
branch with 3 versions of documentation: 55, 54, and 53