diff --git a/docs/API/index.rst b/docs/API/index.rst index 2077de3..7e09712 100644 --- a/docs/API/index.rst +++ b/docs/API/index.rst @@ -36,6 +36,11 @@ An application can then send this token in the request header for authorization. Endpoints --------- +All Endpoints are documented at https://notfellchen.org/api/schema/swagger-ui/ or at https://notfellchen.org/api/schema/redoc/ if you prefer redoc. +The OpenAI schema can be downloaded at https://notfellchen.org/api/schema/ + +Examples are documented here. + Get Adoption Notices ++++++++++++++++++++ diff --git a/docs/dev/contributing.rst b/docs/dev/contributing.rst index 99c16ea..57ce9f6 100644 --- a/docs/dev/contributing.rst +++ b/docs/dev/contributing.rst @@ -5,7 +5,7 @@ Report a bug ^^^^^^^^^^^^ To report a bug, file an issue on `Github -`_ +`_ Try to include the following information: @@ -29,7 +29,7 @@ To contribute simply clone the directory, make your changes and file a pull request. If you want to know what can be done, have a look at the current `Github -`_. +`_. Get in touch! ^^^^^^^^^^^^^ diff --git a/docs/dev/release.rst b/docs/dev/release.rst index ce1785f..36bc392 100644 --- a/docs/dev/release.rst +++ b/docs/dev/release.rst @@ -5,8 +5,7 @@ What qualifies as release? ^^^^^^^^^^^^^^^^^^^^^^^^^^ A new release should be announced when a significant number functions, bugfixes or other improvements to the software -is made. Usually this indicates a minor release. -Major releases are yet to be determined. +is made. Notfellchen follows `Semantic Versioning `_. What should be done before a release? ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -14,7 +13,7 @@ What should be done before a release? Tested basic functions ###################### -Run :command:`pytest` +Run :command:`nf test src` Test upgrade on a copy of a production database ############################################### @@ -38,4 +37,4 @@ Do a final commit on this change, and tag the commit as release with appropriate git tag -a v1.0.0 -m "Releasing version v1.0.0" git push origin v1.0.0 -Make sure the tag is visible on Codeberg and celebrate 🥳 +Make sure the tag is visible on GitHub/Codeberg and celebrate 🥳