Skip to content
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

Docs reorg #815

Open
cliffckerr opened this issue Dec 9, 2024 · 0 comments
Open

Docs reorg #815

cliffckerr opened this issue Dec 9, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@cliffckerr
Copy link
Contributor

cliffckerr commented Dec 9, 2024

Propose the following reorganization of the docs, following https://diataxis.fr.

In brief, the idea is to turn the tutorials into something more like a "quick start guide" ("showing a single path that works"). Some of the tutorial content, and the developer tutorial content, will be moved to a "user guide" ("how-to guide"), that go into much more depth about the explanation and different possible options for that particular feature.

Current

Tutorials

  • T1 - Getting started
  • T2 - How to build your model
  • T3 - Demographics
  • T4 - Diseases
  • T5 - Transmission
  • T6 - Interventions
  • T7 - Calibration

Developer tutorials

  • Diseases
  • Flexible parameters
  • Analyzers
  • Nonstandard usage

Proposed

Tutorials

  • T1 - Getting started
  • T2 - Building a model
  • T3 - Diseases & transmission
  • T4 - Interventions & analyzers
  • T5 - Workflows

User guide

Introduction

  • What is Starsim?
  • Starsim applications

Basics

  • Model structure
  • The Sim object
  • The People object

Modules

  • Diseases
  • Networks & transmission routes
  • Demographics
  • Interventions
  • Analyzers
  • Connectors

Workflows

  • Multiple runs
  • Calibration
  • Samples
  • Cloud computing

Advanced topics

  • Time
  • Indexing
  • Parameters
  • Distributions
  • Random numbers
  • Performance and profiling
  • Nonstandard usage

Thoughts @JSchripsema-IDM @daniel-klein @robynstuart @RomeshA @pausz @jamiecohen?

@cliffckerr cliffckerr added the documentation Improvements or additions to documentation label Dec 9, 2024
@cliffckerr cliffckerr added this to the Version 2.3.1 milestone Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant