Enable docs navigation breadcrumbs - #1222
Conversation
|
I will automatically update this comment whenever this PR is modified
|
|
This commit was pushed and should be registered as part of this PR but it's not showing up! |
818ab99 to
dabb78d
Compare
saberbrasher
left a comment
There was a problem hiding this comment.
I am neutral towards this feature - I am wondering if it will feel redundant when/ if the PR with the docs restructure is done, though? I am picturing "User Guide" in three places, all near the top of the page, for example. In the current doc structure (TOC all on left side) I think I like it more. Interested to hear thoughts!
|
I certainly don't think it's critical, but I feel it's nice to have, and there's little or no cost (screen space?). It can help provide a reminder of where one is in the hierarchy and gives users the ability to traverse up it. It also gives authors more freedom to name pages without including the full context in the page title, without depriving the user of the full context. E.g. we can title a how-to "Frobulate a globtorb" instead of "How to frobulate a globtorb" and the breadcrumbs will provide the context that it's a how-to. For users who have been linked to the page, there's value there... not so much for users who know it's a how-to because they navigated there manually. |
asteiker
left a comment
There was a problem hiding this comment.
@mfisher87 I am a fan of breadcrumbs. This is a personal preference, however, and I don't have any formal UI/UX knowledge to back that up! But I really don't see a downside here, even for those who don't necessarily utilize them. Especially with the re-org, it can help users familiar with the old structure to reorient themselves.
eb3a2c7
dabb78d to
eb3a2c7
Compare
Description
E.g. at the top of a page:
Home > User guide > How-to > Some how-to"Ready for review" checklist
Merge checklist
closes #1)CHANGELOG.mdupdatedREADME.mdupdatedpre-commit.ci autofixif pre-commit is failing)📚 Documentation preview 📚: https://earthaccess--1222.org.readthedocs.build/en/1222/