-
Notifications
You must be signed in to change notification settings - Fork 6
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
Create an Appendix #207
Comments
My few thoughts about this specific idea and a few other things that this all brings up:
@zkamvar Did you have a more specific vision of what the appendix would include and where it would live? |
WRT to the TOC bar, that's something I will look into. The answer is: it ultimately depends on the future of the documentation.
Ironically, these are literally the last items in the user guide at the moment. The "key definitions" and "abbreviations" are both categories of "Reference/Information" (in the diataxis framework). Neither of these pages are great for reading straight (they are the pantry items of documentation... you go to them when you need them). The problem with the "key definitions" at the moment is that they are presented without context, so they feel more like a glossary of terms. I think it's worthwhile to hold off on this issue until I have painted an outline for #211 |
Closing due to this potentially being superseded by additional work on a new website. |
Following @zkamvar's suggestion (#206), I am considering building an Appendix section for the hubverse website. There are two matters for which I want feedback:
Please let me know if I should proceed.
The text was updated successfully, but these errors were encountered: