bump-sh / bump-sh/docs

Add category highlight and breadcrumbs when necessary

Open
#193 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
CSS
Stars
7
Forks
16
Avg merge
3d 1h
Merged PRs (30d)
12

Description

## From a reader's perspective

For now when browsing any of the three categories “Documentation”, “Product updates” or “Guides”, as a reader I don't know in which of these categories I am.

## My thoughts on how to solve

In the Documentation, we have a sidebar which helps to navigate and understand we are in the same “space”. So it's kind of ok.

But in both the “product updates” and “Guides” category, the reader doesn't really know where he is. In my opinion that's because of two reasons:
- We could highlight the category in the top nav bar

I'm thinking of something like:
![Capture d’écran du 2024-03-20 09-46-08](https://github.com/bump-sh/docs/assets/904193/e8844888-c5db-483e-9cfb-f4dfb4fe142d)
- We could have a breadcrumb below the top nav bar:
- in case of the “product updates” it could be a date/time slider for example
- in case of the “Guides” it could be the main categories (which we already have in the home page of guides, but loose when reading an article)
![Capture d’écran du 2024-03-20 09-47-41](https://github.com/bump-sh/docs/assets/904193/85dea8d3-9cff-447b-8101-3a15477796fc)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.