Proposal for Documentation Reorganization

Hey everyone!
I was thinking about reorganizing the documentation to improve clarity and usability. Here’s the proposed structure:

Home (README)
Quickstart (Installation + Package Overview: Splitter, Perturbator, and Analysis classes)
Documentation (APIs, details on classes and methods)
Usage Examples (Notebooks with practical examples)
Contribution (Guidelines for contributing)

In my fork,
👉 I revamped the README to be more appealing to a broader audience.
I also modified the Quickstart section to align with this idea and the proposal above.

I’d love your feedback on whether the Quickstart section information is accurate—I’m still new to the package, so there might be some errors in definitions or concepts. (The Python notebooks currently in the docs are safe and should still be included in some form.)

For inspiration, I looked at the documentation structures of:

Ambrosia
pysurvival

Why This Change?
- Makes it easier for new users to navigate and understand the package.
- Provides a clearer structure for future contributors.
- The examples section can be refined over time for better clarity and accuracy.
- In the future, we could also add a "Stats 101" section for foundational concepts.

Let me know what you think!

@david26694 @ludovico-lanni

Reorg docs #225

Description

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions