Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Customize docs breadcrumbs #152

Merged
merged 3 commits into from Oct 2, 2023
Merged

Customize docs breadcrumbs #152

merged 3 commits into from Oct 2, 2023

Conversation

josh-collinsworth
Copy link
Contributor

@josh-collinsworth josh-collinsworth commented Sep 29, 2023

  • Shows breadcrumbs at all times (unless the user is on a landing page and hasn't begun to navigate any deeper yet)
  • Changes the "home" link in the docs to go to the current section's home (/kv, /runtime, or /deploy, as the case may be)
  • Slightly modifies styling of breadcrumbs
image CleanShot 2023-09-29 at 10 58 03@2x

Copy link
Contributor

@marvinhagemeister marvinhagemeister left a comment

Choose a reason for hiding this comment

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

Nice!

@josh-collinsworth
Copy link
Contributor Author

josh-collinsworth commented Sep 29, 2023

Hmmm now that I'm looking at this, though…I think there's a missing item there. 🤔

Actually, I think that's just a reflection of our current file structure. Our categorization tree doesn't always align 1:1 with the file tree.

@kwhinnery
Copy link
Collaborator

In terms of visuals and behavior I think this is what we want, but we will need to make these under pages actually do something now because the client-side navigation isn’t redirecting /kv to /kv/manual (for example) as is happening in prod right now. We could move the quick start for each product to this path and redirect the manual index page.

@josh-collinsworth
Copy link
Contributor Author

@kwhinnery I noticed that the KV "home" route said it redirected in prod; I assumed that was the case for all of them. I guess I should have checked.

Would that concept where everything is moved to an accordion help here, or does that still have the same issue? Mainly just curious.

@kwhinnery
Copy link
Collaborator

WRT the redirects - Docusaurus does client-side routing for the pages it can detect in the folders containing the content. Previously, we didn't have any Docusaurus-generated client-side links to the home pages for any of /kv, /runtime, or /deploy, so the only time those routes would have been requested was when the server had to try and render those pages. And then on the server, we redirected /kv to /kv/manual, etc.

But now that we have a solution for breadcrumbs and have started manually specifying the sidebar contents, we can move the "quick start" content back to the base routes for /kv, /runtime, and /deploy. Will update your branch with this.

@kwhinnery
Copy link
Collaborator

Going to fix the hover state real quick also:
image

@kwhinnery kwhinnery merged commit a01ce69 into main Oct 2, 2023
3 checks passed
@dsherret dsherret deleted the joco/sidebar branch November 24, 2023 16:23
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.

None yet

3 participants