Documentation refactor #171
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mehalter
approved these changes
Apr 18, 2024
|
Okay, went through the blog and the AlgebraicJulia website and this PR won't break any existing links. I found one broken link that I opened a PR to fix, but it was already broken. |
|
thanks @mehalter! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR rebuilds the epidemiology focused documentation into a clearer path that follows the royal society paper (https://doi.org/10.1098/rsta.2021.0309), more clearly separating into 1) composition 2) stratification followed by the third tutorial which is the complex strain-vacciation-travel model.
It also reorganizes the sidebar (see screenshot) for a better separation of tutorials by theme, and gives some advice on what to read, in what order. The goal of this PR is to make the documentation friendlier to new users.