Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Add a version picker UI to the documentation website #11647

Open
anoadragon453 opened this issue Dec 27, 2021 · 5 comments
Open

Add a version picker UI to the documentation website #11647

anoadragon453 opened this issue Dec 27, 2021 · 5 comments
Assignees
Labels
A-Docs things relating to the documentation T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.

Comments

@anoadragon453
Copy link
Member

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.

@anoadragon453 anoadragon453 added A-Docs things relating to the documentation T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks. labels Dec 27, 2021
@anoadragon453
Copy link
Member Author

@anoadragon453 anoadragon453 changed the title Add a version switcher UI to the documentation website Add a version picker UI to the documentation website May 18, 2022
@OsirisMedici
Copy link

I'd like to contribute to this issue and will start investigating the cause of the problem.

Let me know if you're also working on this. Excited to contribute!

@OsirisMedici
Copy link

@anoadragon453 is this issue closed Sir?

@anoadragon453
Copy link
Member Author

anoadragon453 commented Feb 22, 2023

This issue is still open, and as far as I know nobody is working on it.

@OsirisMedici
Copy link

@anoadragon453 Can you assign this issue to me Please?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Docs things relating to the documentation T-Task Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.
Projects
None yet
Development

No branches or pull requests

2 participants