FSharp.Formatting
FSharp.Formatting copied to clipboard
Nesting Document Categories
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).
- 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
---
- Additional Metadata
We could add an additional tag such as
parentCategorywhich 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.
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.