Skip to content

Conversation

@musslick
Copy link
Collaborator

Description

The PR contains a number of small documentation updates (see features for details)

Type of change

  • docs: Documentation only changes

Features (Optional)

  • added new illustrations for state logic, state wrappers, and contributor model
  • updated README to pint to real-world example and to reflect updated funding
  • updated terminology page
  • included state and state_wrapper illustrations into tutorials

Remarks (Optional)

  • image links for new illustrations in tutorials will be working once the illustrations are on the repo. They require us to point to the absolute path, otherwise the illustrations aren't rendered on Google Colab.

@musslick musslick added the documentation Improvements or additions to documentation. label Oct 21, 2024
@musslick musslick added this to the JOSS Revision milestone Oct 21, 2024
@musslick musslick self-assigned this Oct 21, 2024
Copy link
Collaborator

@younesStrittmatter younesStrittmatter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very good. Way more neat now

@musslick musslick added this pull request to the merge queue Nov 10, 2024
Merged via the queue into main with commit 5a6838d Nov 10, 2024
16 checks passed
@musslick musslick deleted the doc/minor-updates branch November 10, 2024 19:24
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

Successfully merging this pull request may close these issues.

3 participants