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.

Sign up for GitHub

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

Jump to bottom

version picker for the docs website #2064

Open
the-mikedavis opened this issue Apr 10, 2022 · 1 comment
Open

version picker for the docs website #2064

the-mikedavis opened this issue Apr 10, 2022 · 1 comment
Assignees
@the-mikedavis
Labels
A-documentation Area: Documentation improvements C-enhancement Category: Improvements

Comments

@the-mikedavis
Copy link
Member

The docs website (docs.helix-editor.com) is published on pushes to master /master/<path> and on releases /<path> since #1783. It's not clear from a glance at the page whether you're viewing the release docs or master docs.

Elixir's ex_doc documentation tool has a good way to deal with documentation for multiple versions: a <select> for the versions which navigates you to the correct URL. (Below "Elixir" and above "MODULES" on the top-left hand part of this page: https://hexdocs.pm/elixir/Supervisor.html). We probably don't need something as fancy since we only publish the two versions. Something as simple as a link between the versions would be helpful: master docs link to release and release docs link to master.
@the-mikedavis the-mikedavis added A-documentation Area: Documentation improvements C-enhancement Category: Improvements labels Apr 10, 2022
@the-mikedavis the-mikedavis mentioned this issue Apr 10, 2022
Closed
@the-mikedavis the-mikedavis self-assigned this Apr 16, 2022
the-mikedavis added a commit to the-mikedavis/helix that referenced this issue Apr 16, 2022
@the-mikedavis
Add a version selection component to the documentation
dbaa428 
closes helix-editor#2064

This adds a small `select` element that can be used to navigate
between the release and master docs. The select appears in the
navigation pane to the right of the "Helix" header. Your path is
preserved while navigating, so if you are on the keybindings page
on master and set the select to 22.03, you jump to the keybindings
page on 22.03.
@the-mikedavis the-mikedavis mentioned this issue Apr 16, 2022
Closed
@the-mikedavis
Copy link
Member Author

Instead this should be done as an index page that selects the version for the docs so it's really clear. Clippy has a really nice example of this: https://github.com/rust-lang/rust-clippy/blob/gh-pages/index.html. (See #2137 (comment))

@goyalyashpal goyalyashpal mentioned this issue Jan 21, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@the-mikedavis the-mikedavis

Labels
A-documentation Area: Documentation improvements C-enhancement Category: Improvements
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add a version selection component to the documentation the-mikedavis/helix
1 participant
@the-mikedavis