Skip to content

Enable docs navigation breadcrumbs - #1222

Merged
mfisher87 merged 2 commits into
mainfrom
docs-breadcrumbs
Feb 19, 2026
Merged

Enable docs navigation breadcrumbs#1222
mfisher87 merged 2 commits into
mainfrom
docs-breadcrumbs

Conversation

@mfisher87

@mfisher87 mfisher87 commented Feb 17, 2026

Copy link
Copy Markdown
Member

Description

E.g. at the top of a page: Home > User guide > How-to > Some how-to


"Ready for review" checklist

  • Open PR as draft
  • Please review our Pull Request Guide
  • Mark "ready for review" after following instructions in the guide

Merge checklist

  • PR title is descriptive
  • PR body contains links to related and resolved issues (e.g. closes #1)
  • If needed, CHANGELOG.md updated
  • If needed, docs and/or README.md updated
  • If needed, unit tests added
  • All checks passing (comment pre-commit.ci autofix if pre-commit is failing)
  • At least one approval

📚 Documentation preview 📚: https://earthaccess--1222.org.readthedocs.build/en/1222/

@github-actions

github-actions Bot commented Feb 17, 2026

Copy link
Copy Markdown

Binder 👈 Launch a binder notebook on this branch for commit 85a293a

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit 818ab99

Binder 👈 Launch a binder notebook on this branch for commit dabb78d

Binder 👈 Launch a binder notebook on this branch for commit eb3a2c7

@mfisher87
mfisher87 marked this pull request as ready for review February 17, 2026 22:42
@mfisher87

Copy link
Copy Markdown
Member Author

818ab99

This commit was pushed and should be registered as part of this PR but it's not showing up!

@saberbrasher saberbrasher left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@mfisher87

mfisher87 commented Feb 19, 2026

Copy link
Copy Markdown
Member Author

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
asteiker previously approved these changes Feb 19, 2026

@asteiker asteiker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

saberbrasher
saberbrasher previously approved these changes Feb 19, 2026
@mfisher87
mfisher87 dismissed stale reviews from saberbrasher and asteiker via eb3a2c7 February 19, 2026 19:23
@mfisher87
mfisher87 merged commit f2fd722 into main Feb 19, 2026
12 checks passed
@mfisher87
mfisher87 deleted the docs-breadcrumbs branch February 19, 2026 19:36
@github-project-automation github-project-automation Bot moved this to ✅ Done in earthaccess Mar 3, 2026
@mfisher87 mfisher87 removed this from earthaccess Mar 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants