From 949dbf0bfa4d680b49bbc131fbd5529222cf4b9b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20S=C3=B6derberg?= Date: Mon, 27 Nov 2023 19:26:01 +0100 Subject: [PATCH] chore: update the README.md --- README.md | 8 ++++++-- docs/index.md | 2 -- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e42a689..1f8ae47 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ -# cloud-docs -Documentation for Cloud v2 +# cloud-docs [![Documentation Status](https://readthedocs.org/projects/incendocloud/badge/?version=latest)](https://cloud.incendo.org/en/latest/?badge=latest) + +Documentation for Cloud v2. +The docs are written in markdown using [MkDocs](https://www.mkdocs.org/). +The docs are automatically built & deployed when pushing to the `main` branch and the docs are available on [cloud.incendo.org](https://cloud.incendo.org). +Each PR will deploy a temporary preview version of the site. diff --git a/docs/index.md b/docs/index.md index 5d1de74..2bb4cb3 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,3 @@ # Cloud Hello :) - -This is a very important change!