Tweak doc titles, add "make docs", change indigo color to white, add docs about docs

Makefile

@@ -160,6 +160,15 @@ golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
 $(GOLANGCI_LINT): $(LOCALBIN)
 	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))
 
+.PHONY: docs
+docs:
+	cd ./docs && \
+		python3 -m venv .venv && \
+		source .venv/bin/activate && \
+		pip install -r requirements.txt && \
+		cd .. && \
+		mkdocs serve
+
 # go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
 # $1 - target path with name of binary
 # $2 - package url which can be installed

docs/README.md

@@ -107,13 +107,12 @@ Any vLLM or Ollama model can be served by KubeAI. Some examples of popular model
 
 ## Documentation
 
-Checkout the [docs](https://www.kubeai.org) at [kubeai.org](https://www.kubeai.org) for more information.
+Checkout our documenation on [kubeai.org](https://www.kubeai.org) to find info on:
 
-The docs have the following content:
-* Environment Installation Guides (e.g. GKE).
+* Installing KubeAI in the cloud
 * How to guides (e.g. how to manage models and resource profiles).
-* Concept (e.g. explain how Model and Resource Profile work).
-* Contributor Guide
+* Concepts (how the components of KubeAI work).
+* How to contribute
 
 ## OpenAI API Compatibility
 

docs/contributing/development-environment.md

@@ -1,4 +1,4 @@
-# How to setup a development environment
+# Development environment
 
 This document provides instructions for setting up an environment for developing KubeAI.
 

docs/contributing/documentation.md

@@ -0,0 +1,23 @@
+# Documentation
+
+We are grateful for anyone who takes the time to improve KubeAI documentation! In order to keep our docs clear and consistent we ask that you first read about the approach to documentation that we have standardized on...
+
+## Read before writing!
+
+The KubeAI approach to documentation is loosely inspired by the [Diataxis](https://diataxis.fr/) method.
+
+TLDR on how KubeAI docs are organized:
+
+* **Installation**: How-to guides specific to installing KubeAI.
+* **How To**: Directions that guide the reader through a problem or towards a result. How-to guides are goal-oriented. They assume the user is familiar with general concepts, tools, and has already installed KubeAI.
+* **Concepts**: A reflective explanation of KubeAI topics with a focus on giving the reader an understanding of the why.
+* **Tutorials**: Learning oriented experiences. Lessons that often guide a user from beginning to end. The goal is to help the reader *learn* something (compared to a how-to guide that is focused on helping the reader *do* something).
+* **Contributing**: The docs in here differ from the rest of the docs by audience: these docs are for anyone who will be contributing code or docs to the KubeAI project.
+
+## How to serve kubeai.org locally
+
+Make sure you have python3 installed and run:
+
+```bash
+make docs
+```

docs/how-to/manage-models.md

@@ -1,4 +1,4 @@
-# How to manage models
+# Manage models
 
 This guide provides instructions on how to perform CRUD operations on KubeAI [Models](../concepts/models.md).
 

docs/how-to/manage-resource-profiles.md

@@ -1,4 +1,4 @@
-# How to manage resource profiles
+# Manage resource profiles
 
 This guide will cover modifying preconfigured [resource profiles](../concepts/resource-profiles.md) and adding your own.
 

docs/installation/gke.md

@@ -1,8 +1,4 @@
----
-title: "Install KubeAI on GKE"
----
-
-# Install KubeAI on GKE
+# Install on GKE
 
 <details markdown="1">
 <summary>TIP: Make sure you have enough quota in your GCP project.</summary>

mkdocs.yml

@@ -1,8 +1,13 @@
 site_name: KubeAI
 site_url: https://www.kubeai.org
 repo_url: https://github.com/substratusai/kubeai
+
 theme:
   name: material
+  palette:
+    primary: white # Defaults to indigo.
+    accent: blue # Defaults to indigo.
+
 nav:
   - Home: README.md
   - ... | installation/*.md