You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The documentation system is a means of organizing user-facing documentation into four categories (tutorials, how-to guides, explanations, & references)
The text was updated successfully, but these errors were encountered:
Oh I like this one. I'm going to modify it a little bit and put it right in the queue, probably for 0.4.0.
briandominick
changed the title
organize navigation bar as per the documentation system
Enable organizing of subject nav by (definable) topic type
Aug 28, 2021
I intend to bake a few sub-features into this one.
First, the system should be user-definable. I love the idea of "The Documentation System" (which i always thought was called Diátaxis but I guess it's the same thing), but I'm not sure it's optimal in all cases. So really we want to make this customizable rather than impose a system, but I'll create default templates for Diátaxis, DITA-style, and the one I'm developing for my broader framework, which is a mix of both.
Also, I want to make it optional to let the user re-sort the menu either by topic type (this approach) or by some other order you can establish in your manifest file. This will just use JavaScript to swap the navs.
Topics will need their type defined somewhere, but we can also bake it into the filename. Say if a filename ends in _t.adoc or _r.adoc, etc, it will indicate a type (tutorial, reference, etc).
The other nice thing is we don't just have to organize the topics this way, we can give them different layouts depending on type, if that is hepful. Tutorials and how-tos often need more of the page for code/example listings, but references are often quite narrow and leave a wide margin.
The documentation system is a means of organizing user-facing documentation into four categories (tutorials, how-to guides, explanations, & references)
The text was updated successfully, but these errors were encountered: