Merge pull request #207 from stefanprodan/dark-mode-docs

Enable dark mode for docs website

README.md

@@ -28,8 +28,8 @@ To get started with Timoni please visit the documentation website at [timoni.sh]
 ## Concepts
 
 If you are familiar with Helm, a Timoni **[module](https://timoni.sh/module/)** is the equivalent of a **chart**,
-a Timoni **[bundle](https://timoni.sh/bundles/)** is the equivalent of an **umbrella chart**,
-and a Timoni **instance** is the equivalent of a Helm **release**.
+a Timoni **[bundle](https://timoni.sh/bundle/)** is the equivalent of an **umbrella chart**,
+and a Timoni **[instance](#timoni-instances)** is the equivalent of a Helm **release**.
 
 ### Timoni Modules
 
@@ -77,7 +77,8 @@ Commands for working with remote modules:
 - `timoni mod pull oci://<module-url> -v <semver> -o <path/to/module>`
 - `timoni mod list oci://<module-url>`
 
-To learn more about modules, please read the [docs](https://timoni.sh/#timoni-modules).
+To learn more about modules, please see the documentation for [Module structure](https://timoni.sh/module/)
+and [Module distribution](https://timoni.sh/module-distribution/).
 
 ### Timoni Instances
 
@@ -152,15 +153,16 @@ Commands for working with bundles:
 - `timoni bundle apply -f bundle.cue`
 - `timoni bundle delete -f bundle.cue`
 
-To learn more about bundles, please see the [Bundle API documentation](https://timoni.sh/bundles/)
-and the [Bundle Runtime API documentation](https://timoni.sh/bundle-runtime/).
-
 Commands for distributing bundles and runtimes:
 
 - `timoni artifact push oci://<artifact-url> -t <tag> -f <path/to/dir>`
 - `timoni artifact pull oci://<artifact-url> -o <path/to/dir>`
 - `timoni artifact list oci://<artifact-url>`
 
+To learn more about bundles, please see the documentation for [Bundle API](https://timoni.sh/bundle/)
+[Bundle Runtime API](https://timoni.sh/bundle-runtime/)
+and [Bundle distribution](https://timoni.sh/bundle-distribution/).
+
 ## Contributing
 
 Timoni is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub pull requests.

docs/bundle-distribution.md

@@ -1,6 +1,6 @@
 # Bundle Distribution
 
-[Bundles](bundles.md) and their [Runtimes](bundle-runtime.md) can be distributed as
+[Bundles](bundle.md) and their [Runtimes](bundle-runtime.md) can be distributed as
 [Open Container Initiative](https://opencontainers.org/) (OCI) artifacts.
 
 ## Artifact format

docs/bundle-runtime.md

@@ -1,6 +1,6 @@
 # Bundle Runtime
 
-While Timoni [Bundles](bundles.md) offer a way to specify the config values in declarative manner,
+While Timoni [Bundles](bundle.md) offer a way to specify the config values in declarative manner,
 not all the configuration values of an application are known ahead of time.
 Some values may be available at runtime, in the Kubernetes cluster where the Bundle is applied.
 

docs/bundles.md → docs/bundle.md

@@ -1,4 +1,4 @@
-# Bundles
+# Bundle
 
 Timoni bundles offer a declarative way of managing the lifecycle
 of applications and their infra dependencies.

docs/comparison.md

@@ -2,8 +2,8 @@
 
 ## Helm
 
-If you are familiar with Helm, a Timoni **[module](bundles.md)** is the equivalent of a **chart**, 
-a Timoni **[bundle](bundles.md)** is the equivalent of an **umbrella chart**,
+If you are familiar with Helm, a Timoni **[module](module.md)** is the equivalent of a **chart**, 
+a Timoni **[bundle](bundle.md)** is the equivalent of an **umbrella chart**,
 and a Timoni **instance** is the equivalent of a Helm **release**.
 
 ### Authoring differences
@@ -28,6 +28,6 @@ and a Timoni **instance** is the equivalent of a Helm **release**.
 - Timoni performs health checks on Kubernetes custom resources, which Helm ignores.
 - Unlike Helm, Timoni doesn't require keeping a copy of all YAML manifests in a Kubernetes secret, eliminating the limit on the number of objects constituting an application.
 - Timoni provides a `apply --diff` command for displaying a preview of the cluster state changes for an upgrade.
-- Timoni [Bundles](bundles.md) offer a declarative way of grouping multiple apps into a deployable unit, serving as an alternative to Helm's umbrella charts.
+- Timoni [Bundles](bundle.md) offer a declarative way of grouping multiple apps into a deployable unit, serving as an alternative to Helm's umbrella charts.
 - Timoni [Runtime API](bundle-runtime.md) offers a way to define values which are fetched from the Kubernetes API (ConfigMaps, Secrets, Custom Resources) and mapped to fields inside a Bundle. 
 - Timoni modules can be referenced by their OCI SHA256 digest, ensuring immutability and reproducibility, unlike Helm charts that are referenced only by version.

docs/index.md

@@ -60,11 +60,13 @@ Commands for vendoring Kubernetes APIs and CRDs:
 - `timoni mod vendor k8s --version latest`
 - `timoni mod vendor crds -f <path/to/crds.yaml>`
 
+To learn more about modules, please see the [module documentation](module.md).
+
 #### OCI Artifacts
 
 Timoni modules are distributed as OCI artifacts and can be stored in container registries
 which support custom OCI media types.
-Modules are versioned using strict [semantic versioning](https://semver.org/),
+Modules are versioned using strict [semantic versioning](module-distribution.md#version-format),
 the version of a module is used as the OCI artifact tag.
 
 Commands for working with remote modules:
@@ -181,8 +183,8 @@ Commands for working with bundles:
 - `timoni bundle apply -f bundle.cue --runtime runtime.cue --diff`
 - `timoni bundle delete -f bundle.cue`
 
-To learn more about bundles, please see the [Bundle API documentation](https://timoni.sh/bundles/)
-and the [Bundle Runtime API documentation](https://timoni.sh/bundle-runtime/).
+To learn more about bundles, please see the [Bundle API documentation](bundle.md)
+and the [Bundle Runtime API documentation](bundle-runtime.md).
 
 Commands for distributing bundles and runtimes:
 

docs/module.md

@@ -1,4 +1,4 @@
-# Module Structure
+# Module
 
 A Timoni module contains a set of CUE definitions and constraints organised
 into a [CUE module](https://cuelang.org/docs/concepts/packages/)

docs/quickstart.md

@@ -111,7 +111,7 @@ timoni -n test delete podinfo --wait
 ## Bundling instances
 
 For deploying complex applications to production, it is recommended to use
-Timoni [Bundles](bundles.md).
+Timoni [Bundles](bundle.md).
 
 A Timoni Bundle is a CUE file for defining a group of instances together
 with their values and module references.
@@ -163,4 +163,5 @@ To delete all the instances defined in a bundle:
 timoni bundle delete -f podinfo.bundle.cue
 ```
 
-To learn more about bundles, please see the [Bundle API documentation](https://timoni.sh/bundles/).
+To learn more about bundles, please see the [Bundle API](bundle.md)
+and the [Bundle distribution](bundle-distribution.md) documentation.

mkdocs.yml

@@ -14,15 +14,32 @@ theme:
   language: en
   custom_dir: docs/theme/
   palette:
-    primary: deep purple
-    accent: indigo
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: deep purple
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: stale
+      primary: black
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
   features:
     - navigation.sections
+    - navigation.top
 
 docs_dir: docs
 
 plugins:
   - search
+  - redirects:
+      redirect_maps:
+        'module-semver.md': 'module-distribution.md'
+        'bundles.md': 'bundle.md'
 
 markdown_extensions:
   - attr_list
@@ -46,11 +63,11 @@ nav:
   - Installation: install.md
   - Quickstart: quickstart.md
   - Topics:
-      - Bundle files: bundles.md
+      - Bundle files: bundle.md
       - Bundle runtime: bundle-runtime.md
       - Bundle distribution: bundle-distribution.md
       - Module structure: module.md
-      - Module distribution: module-semver.md
+      - Module distribution: module-distribution.md
       - Module signing: module-sign.md
       - Values files: values.md
       - Compared to other tools: comparison.md
@@ -64,6 +81,8 @@ nav:
           - Push: cmd/timoni_mod_push.md
           - Pull: cmd/timoni_mod_pull.md
           - List: cmd/timoni_mod_list.md
+          - Vendor Kubernetes APIs: cmd/timoni_mod_vendor_k8s.md
+          - Vendor Kubernetes CRDs: cmd/timoni_mod_vendor_crd.md
       - Instances:
           - Apply: cmd/timoni_apply.md
           - Build: cmd/timoni_build.md