hubverse-org / hubDocs

https://hubverse.io
5 stars 6 forks source link

Create an Appendix #207

Open micokoch opened 2 weeks ago

micokoch commented 2 weeks ago

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:

  1. Where should it live? I think it should be the last section, but I can also see an argument for including it before the Code of Conduct.
  2. What should be included in the Appendix? Here are my suggestions:
    • Key Definitions (currently in Overview)
    • Abbreviations (currently in Overview)
    • Presentations (currently in the User Guide)

Please let me know if I should proceed.

nickreich commented 1 week ago

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?

zkamvar commented 1 week ago

WRT to the TOC bar, that's something I will look into. The answer is: it ultimately depends on the future of the documentation.

I think the presentations should not be buried in the Appendix. I like these in the overview.

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