diff --git a/README.md b/README.md index 65a6de4f..45f7a769 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ Documentation regarding the usage and installation is available at +colibri diagram --- diff --git a/colibri-diagram-blackjax.png b/colibri-diagram-blackjax.png new file mode 100644 index 00000000..129def13 Binary files /dev/null and b/colibri-diagram-blackjax.png differ diff --git a/colibri/doc/README.md b/colibri/doc/README.md index c1b539a1..051ec724 100644 --- a/colibri/doc/README.md +++ b/colibri/doc/README.md @@ -1,3 +1,5 @@ # Colibri code and standards documentation -Here we store the `documentation `_. +Here we store Colibri's [documentation](https://hep-pbsp.github.io/colibri/index.html). + +For instructions on how to contribute to the documentation see the [guidelines](https://hep-pbsp.github.io/colibri/get-started/document.html). \ No newline at end of file diff --git a/colibri/doc/sphinx/source/get-started/index.rst b/colibri/doc/sphinx/source/get-started/index.rst index 656f7447..34895f83 100644 --- a/colibri/doc/sphinx/source/get-started/index.rst +++ b/colibri/doc/sphinx/source/get-started/index.rst @@ -16,3 +16,4 @@ If you use the public Colibri code, please cite all references listed in :ref:`c ./installation.rst ./first-fit.rst ./cite.rst + ./document.rst