This is the official documentation for ALADIN and it's surrounding components, such as CARPET and DJINN. It is build as a Jupyter Book and changes on the develop branch are automatically deployed via a Github-Action workflow.
For more details see the Jupyter Book Documentation and its Cookiecutter installation.
To contribute to the documentation directly, fork the repository and make your changes in a seperate branch with a meaningful name and issue a pull request. After the pull request has been accepted and merged into the develop branch the changes will go live.
You can also suggest changes or request more information for parts of the documentation that feel insufficient to you. The easiest way to do this is by opening an issue directly via the rendered Jupyter Book on the page that you feel needs changes. This can be done by hovering over the Github-logo on the top of the Jupyter Book and selecting Open Issue.
To render Mermaid diagrams correctly with Sphinx, the Myst syntax is required.
The Myst syntax differs from regular markdown in that the specified code flavor in the top of a code block needs to be wrapped into curly braces.
# Myst syntax
{mermaid}
# Markdown syntax
mermaid
To still be able to render the diagrams while editing them in an IDE, the syntax can temporarily be changed to the regular markdown syntax.
For more details see here.