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

Clickable breadcrumbs #2779

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Conversation

Blargian
Copy link
Collaborator

@Blargian Blargian commented Nov 12, 2024

Closes #2636. Introduces changes to clean up the navigation of docs together with 71846 over on main repo.

PR will fail due to two missing files which were added in the PR on the main repo

Changes

In many places we show an overview page as a sub-child of the category, such as here:

image

In my opinion this clutters the sidebar, especially when the overview page has the same name as the category. This PR makes a small change to the sidebarItemsGenerator such that any file ending index.md will not show as a sub-child of the category. The category itself is then given the link to the overview or index page and becomes clickable:

image

Further more, breadcrumbs often did not link to anywhere such as here, because 'introduction' was a category and not a specific page:

image

Index files are added (in a separate PR) in some places and categories in the sidebar linked such that breadcrumbs are clickable:

Screencast from 12-11-2024 22_08_06

Also addresses 2888, adding landing pages where they are missing.

Checklist

@Blargian Blargian marked this pull request as ready for review November 12, 2024 21:25
@Blargian
Copy link
Collaborator Author

DocsCheck fails:

Error:  Loading of version failed for version current
Error:  Unable to build website for locale en.
Error:  Error: Invalid sidebar file at "sidebars.js".
These sidebar document ids do not exist:
- en/engines/index
- en/sql-reference/functions/functions-index

This is because the former is added in #71846 over at main repo and the latter because en/sql-reference/functions/functions-index was previously en/sql-reference/functions/index. Rename happens in that PR as well.

May also need to add a redirect for that.

@Blargian Blargian requested a review from a team as a code owner December 15, 2024 11:55
@Blargian Blargian requested review from mshustov and removed request for a team December 15, 2024 11:55
@Blargian Blargian changed the title Clickable breadcrumbs [WIP] Clickable breadcrumbs Dec 15, 2024
@Blargian Blargian removed the request for review from mshustov December 15, 2024 20:51
@Blargian Blargian changed the title [WIP] Clickable breadcrumbs Clickable breadcrumbs Dec 17, 2024
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.

Clickable breadcrumbs
1 participant