doc: Update branching model (#2816)

Author: dweindl

CONTRIBUTING.md

@@ -9,4 +9,4 @@ or [`help wanted`](https://github.com/AMICI-dev/AMICI/issues?q=is%3Aissue+is%3Ao
 For other ideas or questions, just post an issue.
 
 For code contributions, please read our
-[developer's guide](https://amici.readthedocs.io/en/develop/development.html) first.
+[developer's guide](https://amici.readthedocs.io/en/main/development.html) first.

README.md

@@ -80,22 +80,22 @@ is then used for model simulation.
 The AMICI source code is available at https://github.com/AMICI-dev/AMICI/.
 To install AMICI, first read the installation instructions for
 [Python](https://amici.readthedocs.io/en/latest/python_installation.html),
-[C++](https://amici.readthedocs.io/en/develop/cpp_installation.html) or
-[Matlab](https://amici.readthedocs.io/en/develop/matlab_installation.html).
+[C++](https://amici.readthedocs.io/en/main/cpp_installation.html) or
+[Matlab](https://amici.readthedocs.io/en/main/matlab_installation.html).
 There are also instructions for using AMICI inside
 [containers](https://github.com/AMICI-dev/AMICI/tree/master/container).
 
 To get you started with Python-AMICI, the best way might be checking out this
 [Jupyter notebook](https://github.com/AMICI-dev/AMICI/blob/master/doc/examples/getting_started/GettingStarted.ipynb)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/AMICI-dev/AMICI/develop?labpath=doc%2Fexamples%2Fgetting_started%2FGettingStarted.ipynb).
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/AMICI-dev/AMICI/main?labpath=doc%2Fexamples%2Fgetting_started%2FGettingStarted.ipynb).
 
 To get started with Matlab-AMICI, various examples are available
 in [matlab/examples/](https://github.com/AMICI-dev/AMICI/tree/master/matlab/examples).
 
 Comprehensive documentation is available at
 [https://amici.readthedocs.io/en/latest/](https://amici.readthedocs.io/en/latest/).
 
-Any [contributions](https://amici.readthedocs.io/en/develop/CONTRIBUTING.html)
+Any [contributions](https://amici.readthedocs.io/en/main/CONTRIBUTING.html)
 to AMICI are welcome (code, bug reports, suggestions for improvements, ...).
 
 

doc/conf.py

@@ -154,7 +154,7 @@ def install_doxygen():
 release = version
 
 project = "AMICI"
-copyright = "2020, The AMICI developers"
+copyright = "2015-2025, The AMICI developers"
 author = "The AMICI developers"
 title = "AMICI Documentation"
 

doc/development.rst

@@ -7,11 +7,9 @@ relevant to regular users.
 Branches / releases
 -------------------
 
-AMICI roughly follows the
-`GitFlow <https://nvie.com/posts/a-successful-git-branching-model/>`__.
-All new contributions are merged into ``develop``. These changes are
-regularly merged into ``master`` as new releases. For release versioning
-we are trying to follow `semantic versioning <https://semver.org/>`__.
+For AMICI, we mostly do `trunk-based development <https://trunkbaseddevelopment.com/>`__.
+All new contributions are merged into ``main`` after passing the test suite
+and code review. Releases are usually created directly from ``main``.
 New releases are created on GitHub and are automatically deployed to
 `Zenodo <https://doi.org/10.5281/zenodo.597928>`__ for
 archiving and to obtain a digital object identifier (DOI) to make them
@@ -20,8 +18,7 @@ automatically create and deploy a new release on
 `PyPI <https://pypi.org/project/amici/>`__.
 
 We try to keep a clean git history. Therefore, feature pull requests are
-squash-merged to ``develop``. Merging of release branches to master is
-done via merge commits.
+squash-merged to ``main``.
 
 When starting to work on some issue
 -----------------------------------
@@ -44,12 +41,17 @@ process described below:
    `AMICI's license conditions <https://github.com/AMICI-dev/AMICI/blob/master/LICENSE.md>`__.
    By opening a pull requests you confirm us that you do agree.
 
--  Start a new branch from ``develop`` (on your fork, or at the main
+-  Start a new branch from ``main`` (on your fork, or at the main
    repository if you have access)
 
 -  Implement your changes
 
--  Submit a pull request to the ``develop`` branch
+-  Update ``CHANGELOG.md`` with a short description of your changes.
+   This can be omitted for small changes that do not affect the
+   functionality of AMICI, e.g. fixing typos or formatting issues,
+   private refactoring, ...
+
+-  Submit a pull request to the ``main`` branch
 
 -  Ensure all tests pass
 
@@ -117,7 +119,7 @@ Python
 C++
 ^^^
 
--  We use C++17
+-  We use C++20
 
 -  We want to maintain compatibility with g++, clang, and the Intel C++
    compiler
@@ -126,10 +128,14 @@ C++
    be invoked by ``make clang-format cmake-format`` from the CMake build
    directory.
 
+-  For new code, we use `Google's C++ style guide <https://google.github.io/styleguide/cppguide.html>`__ as a reference.
+
+
 Matlab
 ^^^^^^
 
-*To be defined*
+No new Matlab code should be added to AMICI
+(see `#2727 <https://github.com/AMICI-dev/AMICI/issues/2727>`__).
 
 Further topics
 --------------

doc/python_examples.rst

@@ -4,7 +4,7 @@ Examples
 Various example notebooks.
 
 .. image:: https://mybinder.org/badge_logo.svg
- :target: https://mybinder.org/v2/gh/AMICI-dev/AMICI/develop?labpath=binder%2Foverview.ipynb
+ :target: https://mybinder.org/v2/gh/AMICI-dev/AMICI/main?labpath=binder%2Foverview.ipynb
 
 .. toctree::
    :maxdepth: 1

doc/python_installation.rst

@@ -300,9 +300,9 @@ you can install AMICI with ``pip`` directly from GitHub using:
 
 .. code-block:: bash
 
-    pip3 install -e git+https://github.com/AMICI-dev/amici.git@develop#egg=amici\&subdirectory=python/sdist
+    pip3 install -e git+https://github.com/AMICI-dev/amici.git@main#egg=amici\&subdirectory=python/sdist
 
-Replace ``develop`` by the branch or commit you want to install.
+Replace ``main`` by the branch or commit you want to install.
 
 Note that this will only work on Windows if you have enabled developer mode,
 because symlinks are not supported by default