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

Add a version picker UI to the documentation website #11647

Open
matrixbot opened this issue Dec 19, 2023 · 1 comment
Open

Add a version picker UI to the documentation website #11647

matrixbot opened this issue Dec 19, 2023 · 1 comment

Comments

@matrixbot
Copy link
Collaborator

matrixbot commented Dec 19, 2023

This issue has been migrated from #11647.


The documentation for each Synapse version is stored in each version's respective directory under the gh-pages branch of this repository: https://github.com/matrix-org/synapse/tree/gh-pages. There are additionally develop and latest directories which contain the very latest build of the documentation, and the documentation of the most recent, stable Synapse release respectively.

Currently, individual versions of this documentation is only accessible by navigating to it directly by URL, e.g https://matrix-org.github.io/synapse/v1.40.

Ideally, it would be possible to switch between versions via a button in the website's UI. The website currently lacks such UI.

We can build something from scratch, like what was done for the custom table of contents sidebar: https://github.com/matrix-org/synapse/blob/develop/docs/website_files/README.md

An example of a version switcher that could be used with a little tweaking is the one that can be seen in NixOS' documentation: https://nixos.org/manual/nix/stable/. The JS source for which is available at: https://github.com/NixOS/nixos-homepage/blob/c4a3ed90fbea5386e4060a3f3f623d52b99c9ec4/js/manual-version-switch.js. However, this sort of UI may become unruly when we have 100 different versions of Synapse to sift through, so ideally something that can be scrolled/paginated would be used.

@matrixbot matrixbot changed the title Dummy issue Add a version picker UI to the documentation website Dec 21, 2023
@matrixbot matrixbot reopened this Dec 21, 2023
@dklimpel
Copy link
Contributor

dklimpel commented Mar 25, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants