Skip to content

docs: Add globally visible breadcrumbs without flaky auto-correct

Warren Gifford requested to merge docs/global-breadcrumbs into master

Created by: mrnugget

This might be controversial, but I really think we need a global navbar, so I'm proposing it here. If we don't want it, we can close this PR :)

This PR

  • adds a globally visible "breadcrumbs" to our docs to make navigation and knowing where you are easier.
  • gets rid of the "auto-correct" that we had on breadcrumb items and embraces the file path structure we have. My thinking behind this is: the solution we had tried to make titles out of file paths, which doesn't work that well without meta-data (example: it often failed in its capitalization efforts because it didn't take word-boundaries into account, so "ui" would be capitalized inside every word). So instead we embrace the file paths, which are still pretty readable and don't get us into this uncanny valley where the breadcrumbs kinda, sorta match the headings of the doc files, but not really. Now it's clear that it's file paths, which is okay, because our intended audience are admins and developers.
  • gets rid of the redundant "home" button. The logo in the top left already linked to this and now we have a "docs" link in the breadcrumbs.

@sourcegraph/web I'm not that sure about the CSS, so maybe someone can take a look.

Demo GIF

add_global_navbar

Merge request reports