Improve breadcrumbs and version verbiage #15
Merged
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
"logo_only" doesn't get at what this theme really wants to know, which is if the project is the main docs project or a subproject. This became blindly clear when I needed to know the same thing in a different template, which has nothing to do with logos.
The logo now links to the doc home page, and we can improve wayfinding in other ways, like improving the page breadcrumbs.
- Starts breadcrumbs with the main Nextstrain doc home page to replace the previous "click here" link and situate the subproject within the larger docs. - Replaces home icon with the word "Home" for less mystery-meat nav. - Replaces » with / for separating breadcrumb levels as a more traditional hierarchy marker. - Removes current page title from breadcrumbs to avoid repeating ourselves.
The most common case is now cleaner:
version: stable → nothing
The meaning of "latest" is now clearer:
version: latest → development version
and a useless colon is dropped:
version: X → version X
Versions are always always on their own (centered) line now underneath
the subproject name, instead of potentially sitting alongside them for
short names (like "CLI").
|
Breadcrumbs before/after on main docs site:
on Augur's docs:
(ignore the "View page source" vs. "Edit on GitHub" difference, which is not real.) |
|
Version verbiage before/after for version X:
for version "latest":
for version "stable":
|
huddlej
approved these changes
Jan 27, 2022
tsibley
added a commit
that referenced
this pull request
Jan 28, 2022
Make it even clearer what software revisions those labels represent.
A `git describe` style string¹ for development ("latest") would be even
better than just the git revision, but that appears to be non-trivial to
implement.
Resolves <nextstrain/augur#817>.
h/t to @corneliusroemer for the suggestion and @huddlej for bringing it
up again in <#15>.
¹ e.g. "${tag}-${n}-g${sha}" where ${tag} is the last/closest tag to the
current commit, ${n} is the number of commits since that ${tag}, and
${sha} is the shortened id of the current commit.
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.
See commit messages for details.