Allow the user to select the version of the docs #17434
Open
+81
−8
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
Checklist
gh-pages
branch with 3 versions of documentation: 55, 54, and 53