docs: update and complete Helm chart documentation, add MkDocs support

Updated README.md files for better clarity and usage instructions, added `mkdocs.yml` to enable documentation site generation, and introduced custom CSS styling for MkDocs.

README.md

@@ -2,20 +2,17 @@
 
 This project contains the Helm charts required to running the Katie AI Agent for Kubernetes on an existing cluster.
 
-# Usage
-
-
 # Usage
 Prerequisites:
  - [Helm](https://helm.sh/)
  - Kubernetes
 
 Once helm is installed and configured, add the repo as follows:
-TBD
 
-You can then run `helm search repo deep` to see the charts.
+`helm repo add katie https://intergral.github.io/katie-helm/`
+
+You can then run `helm search repo katie` to see the charts.
 
 # Docs
-There are multiple charts in this repo, each is documented below:
 
-TBD
+https://intergral.github.io/katie-helm/katie

charts/katie-agent/README.md

@@ -1,6 +1,6 @@
 # Katie-Agent Helm Chart
 
-__TBD__ This README.md needs to be completed.
+This chart installs the Katie agent into your cluster.
 
 ## Installing
 
@@ -16,11 +16,11 @@ config:
     name: "Your Cluster Name"
 ```
 
-The key `config.cluster.name` is defaulted to `Default Cluster` - if this isn't okay for you (perhaps beacuse you have multiple clusters, or which to have a more descriptive cluster name), it can be changed.
+The key `config.cluster.name` defaults to `Default Cluster` - if this isn't okay for you (perhaps beacuse you have multiple clusters, or which to have a more descriptive cluster name), it can be changed here.  The key `config.endpoint.apiKey` must be supplied or the deployed agent pod will not start (_but see note below_).
 
 #### API Key Alternatives
 
-The destination for the `config` element is a `ConfigMap`.  If you wish to store the API key somewhere else, omit this element from the values file, and supply a block in `env` conformant with `Pod > .spec.containers.env` which will be inserted varbatim into the deployment.  
+The destination for the `config` element is a `ConfigMap`.  If you wish to store the API key somewhere else, omit this element from the values file, and supply a block in `env` conformant with `Pod > .spec.containers.env` which will be inserted varbatim into the deployment.
 
 This block could, for example, use `valueFrom` together with `secretKeyRef` to obtain the `apiKey` from a secret.
 
@@ -30,9 +30,9 @@ If `serviceAccount.create` is `true` (default), the chart will create a Service
 
 In this case, two Cluster Roles will be created:  one with read-write privileges and one with read-only.
 
-The read-write version is default but the read-only version can be selected by setting `config.cluster.role.readOnly` to `false`.
+The read-write version is default but the read-only version can be selected by setting `config.cluster.role.readOnly` to `true`.
 
-The difference is in the verbs allowed against the cluster.  The read-only version allows only:
+The difference is in the verbs allowed to be executed against the cluster.  The read-only version allows only:
 * GET
 * LIST
 * WATCH
@@ -44,8 +44,4 @@ The difference is in the verbs allowed against the cluster.  The read-only versi
 * PATCH
 * UPDATE
 
-If you wish to create your own RBAC constellation, set `serviceAccount.create` to `false` and ensure a service account exists prior to deploying.  The name of this account is of the form `RELEASE_NAME-katie-agent`.  So, for example, if your release name was 'production', the name sought for the `serviceAccount` would be `production-katie-agent`.
-
-### Examples
-
-__TBD__
+If you wish to create your own RBAC constellation, set `serviceAccount.create` to `false` and ensure a service account exists prior to deploying.  The name of this account is of the form `RELEASE_NAME-katie-agent`.  So, for example, if your Helm release name was 'production', the name sought for the `serviceAccount` would be `production-katie-agent`.

mkdocs.yml

@@ -0,0 +1,25 @@
+repo_name: Katie Helm Charts
+repo_url: https://github.com/intergral/katie-helm
+
+docs_dir: docs_out
+site_dir: _site
+
+site_name: Katie Helm Charts
+site_url: https://intergral.github.io/katie-helm/
+
+copyright: Intergral GmbH 2024
+
+theme:
+  name: material
+  features:
+    - content.code.copy
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+

styles.css

@@ -0,0 +1,3 @@
+.md-grid {
+    max-width: 100rem;
+}