Skip to content
This repository has been archived by the owner on Apr 25, 2023. It is now read-only.

Updates to "breadcrumbs" & links in docs pages #406

Closed
jay-khatri opened this issue Mar 7, 2023 · 3 comments · Fixed by #416
Closed

Updates to "breadcrumbs" & links in docs pages #406

jay-khatri opened this issue Mar 7, 2023 · 3 comments · Fixed by #416
Assignees

Comments

@jay-khatri
Copy link
Contributor

Task 1: links to headings

For our docs, we don't render the index.md doc in the left panel by design. For example, there is no way to get to https://www.highlight.io/docs/general/company from the left sidebar here:

Image

However, by clicking the link, the page still exists.

We should handle this by redirecting this ^ link to the first child of the heading. In this case, we should redirect https://www.highlight.io/docs/general/company to https://www.highlight.io/docs/general/company/values.

Task 2: breadcrumbs

As a second step, we should make these breadcrumbs clickable. Given the above change, this will mean that clicking on "Company" and "Mission & Values" should take you to the same place.

Image

@jay-khatri
Copy link
Contributor Author

cc @ccschmitz if you have anything to add. Thanks for reminding of this today.

@jay-khatri jay-khatri assigned Crawron and unassigned Abhishek-More Mar 7, 2023
@ccschmitz
Copy link
Contributor

We should handle this by redirecting this ^ link to the first child of the heading. In this case, we should redirect https://www.highlight.io/docs/general/company to https://www.highlight.io/docs/general/company/values.

Might be worth trying to hide these in our search results as well, otherwise we show a few options for language/framework searches and it's not clear where to start.

image

@Crawron
Copy link
Collaborator

Crawron commented Mar 8, 2023

Fixed in #416

Crawron added a commit that referenced this issue Mar 8, 2023
- Redirects to first non-index children in the list when the page
visited is an index

- Makes all breadcrumbs in docs pages clickable

Fixes #406
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants