Documentation structure

[digicosmos86]

Here's what I propose for the structure of our documentation:

Home Getting started

• Installation
• Usage #104 API documentation
• HSSM
• dist_utils Tutorials
• Arviz integration #107
• HDDM --> HSSM #109
• HuggingFace Integration #108
• Custom likelihood #105
• Low level usage with PyMC #106 Contributing
• Hugging Face
• Contributing to code base

Let me know what you think. Feel free to add and remove stuff. Number after "#" is issue number

[digicosmos86]

@AlexanderFengler and @AisOmar If this structure looks OK with you I can do a PR with these structural changes. Just want to be clear about who is working on what

[AisOmar]

sounds good to me, the naming can be more descriptive: Introduction

Getting started

• Step-by-step Installation Instructions (formerly "Installation")
• A Comprehensive Guide on How to Use HSSM (formerly "Usage #104") API Reference (formerly "API documentation")
• Understanding and Using the HSSM API (formerly "HSSM")
• A Detailed Guide to Distribution Functions (formerly "dist_utils")

Tutorials

• Integrating Arviz with HSSM: A Step-by-step Guide (formerly "Arviz integration #107")
• Transitioning from HDDM to HSSM: A Comprehensive Guide (formerly "HDDM --> HSSM #109")
• How to Integrate HSSM with HuggingFace Models (formerly "HuggingFace Integration #108")
• How to Define Custom Likelihood Functions (formerly "Custom likelihood #105")
• Leveraging PyMC for Low-Level HSSM Usage (formerly "Low level usage with PyMC #106")

Contribution Guidelines (formerly "Contributing")

• How to Contribute to the HSSM Hugging Face (formerly "Hugging Face")
• How to Contribute to the HSSM Code Base (formerly "Contributing to code base")

[AlexanderFengler]

Good with the slightly expanded titles that @AisOmar suggested, so starting form there:

Some suggestions: Tutorials

• Integrating Arviz with HSSM --> ArviZ for plotting with HSSM

Contribution Guidelines --> Contribute

• How to Contribute to the HSSM Hugging Face --> Contribute to the HSSM model reservoir
• Leveraging PyMC for Low-Level HSSM usage --> Low-level HSSM functionality for direct interface with PyMC

[digicosmos86]

Sounds good! The titles that I suggested were definitely just some placeholders lol. I am good with the suggestions. I'll get started working on it