Improve overall navigation options in sidebar #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows all docs pages built with this theme to have an easy and obvious way to get to the main nextstrain.org site. Future commits will provide an obvious path to the main docs.nextstrain.org page.
This makes it clear that users are within a subproject and provides a simple link to go back to the main docs. This text can be removed / rewritten when we move to a unified TOC between subprojects. Note that the version does not show up locally, but it does on RTD builds.
eharkins
approved these changes
Nov 3, 2020
There was a problem hiding this comment.
This looks great and most importantly is a good solution to having a way back to the main docs project (nextstrain/docs.nextstrain.org#12) until we can have a shared toctree as you mention (nextstrain/docs.nextstrain.org#27).
|
Thanks @eharkins -- could I get you to merge & release as per last time? Thanks 🙏 |
|
Released this in 2020.5 to pypi. Thanks James! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of proposed changes
This PR provides users with a clear way to return to the main nextstrain.org site (via the nextstrain logo, which is consistent with other parts of the nextstrain ecosystem) and, when within a subproject's docs provides a clear way to return to return to the main docs.nextstrain.org docs. Note that the second part here will be much improved by our plans to move to a unified TOC.
Screenshot of Augur docs (branch
migrate-docs) build under this theme:(Note that the version information doesn't come up when built locally, but should appear on the RTD build.)