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

Nesting Document Categories #927

Open
1eyewonder opened this issue Jun 28, 2024 · 1 comment
Open

Nesting Document Categories #927

1eyewonder opened this issue Jun 28, 2024 · 1 comment

Comments

@1eyewonder
Copy link
Contributor

Feature Request

I've been using this tool a lot more as of late, and I was curious if the discussion of nesting categories has ever come about.

Using the example structure below

Collections
| -- Overview
| -- Destructuring with Cons
| -- Pattern Matching Lists
| -- Pattern Matching Arrays

I think it would be nice to be able to create nested/subcategories like so.

Collections
| -- Overview
| -- Arrays
    | -- Pattern Matching
| -- Lists
    | -- Destructuring with Cons
    | -- Pattern Matching

My initial thoughts are we could potentially do this one of two ways (I'm sure there are better ideas as well).

  1. Special Character Parsing
    We could add some sort of character sequence which would be parsable for category so we know how to nest the folder appropriately.
---
category: Collections -> Lists
---
  1. Additional Metadata
    We could add an additional tag such as parentCategory which tells us how to nest the folder appropriately.
---
category: Lists
parentCategory: Collections
---

Notes

  • If this is a desired feature, I would be willing to assist/work on this.
  • If this would come to pass, I can see people requesting the ability for the UI categories to be collapsible. I would imagine we'd want a way for the user to decide if they wanted the categories opened or closed on startup.
@nojaf
Copy link
Collaborator

nojaf commented Jun 28, 2024

Hi there,

I have some faint memories of this being requested by someone somewhere.
I don't think I mind this feature but the implementation could be tricky.
Things like the {{fsdocs-next-page-link}} become more complex.
Navigation menus should also be taken into account.

I suppose we do want to be flexible and allow multiple levels of categories.
Not sure yet on the end-user experience.

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