From e3652f9870eb2dae0f67d1e078b5f8ad28b274e2 Mon Sep 17 00:00:00 2001 From: Tom Brews Views Date: Thu, 8 Feb 2024 19:08:54 +0100 Subject: [PATCH] extend readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bba6988..b23e391 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,9 @@ # docs -To run localy `mkdocs serve` +To run localy: `mkdocs serve` + +To expand and customize the theme: [Material MKDocs](https://squidfunk.github.io/mkdocs-material/) + +The deployment is managed on the gh-pages branches. +After each merge to main the deplloyment will be taken care of by GH action automatically and the new version will be available at: [Docs](https://codium-ai.github.io/docs/) + +Github action is located in `.github/workflows/ci.yml` file. \ No newline at end of file