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

Section bundles more hierarchy-focused #1083

Open
smythp opened this issue Aug 21, 2023 · 0 comments
Open

Section bundles more hierarchy-focused #1083

smythp opened this issue Aug 21, 2023 · 0 comments

Comments

@smythp
Copy link

smythp commented Aug 21, 2023

Summary

Currently, section bundles (accessed primarily through breadcrumb links) show a list of all content pages under that heading recursively. I propose to render down only to the next level and include section bundles in the generated list, allowing traversal one node at a time.

Basic example

-- Docs
  -- About
    |
    -- history.md
    -- contributing.md
  -- API
    |
    -- reference.md
    -- guide.md

Currently, if you go to the section bundle for docs by clicking the "docs" link in the breadcrumb, the page will show you all four content pages (history, contributing, reference, guide).

What I'm proposing would be to have the docs section bundle show instead About and API. When clicking through on those, you would see the content pages under those. This seems like a more intuitive way to navigate the project.

Background

We recently used Doks in a replatform for the Sigstore docs. (thanks, the theme has been great to work with, and you've been extremely helpful.) I implemented this proposed change for our site (try navigating by breadcrumbs or visiting the docs section bundle. Edit: we removed the "docs" breadcrumb level for backward compatability..

Thanks again, and no worries if you (understandably) like the section bundles the way they are.

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

1 participant