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

Add crumtrail to command pages. #1094

Open
savente93 opened this issue Oct 3, 2023 · 1 comment
Open

Add crumtrail to command pages. #1094

savente93 opened this issue Oct 3, 2023 · 1 comment

Comments

@savente93
Copy link
Contributor

Currently it is a bit hard to navigate around the docs vertically. for example let's say I just searched for path expand and it's close but not exactly want I want. I want to look around the other path subcommands to see if I can see something that works better. currently there is no way to navigate up one part. This makes it even harder if it's not clear which subsection something is under (e.g. get I for the life of me cannot find it's parent page). not being able to navigate up in the tree makes navigation very difficult imo

@NotTheDr01ds
Copy link
Contributor

This would be useful. Unfortunately the default Vuepress theme doesn't support breadcrumbs, so it would involve either changing to a theme with that feature or adding it at the theme level, I believe.

Also problematic is that there really isn't a single "parent" page for the commands themselves. They are auto-generated into /commands/docs/<command>, the categories indices are auto-generated into /commands/categories/<category>, and then master index of all commands is auto-generated at /commands. Is the "parent" page the "Category" or the main "Index"? When visiting a command from a search result, there's really no way for the SSG to know in order to add a breadcrumb "up".

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

No branches or pull requests

2 participants