feat(docs): migrate documentation to MkDocs with auto-generated API reference

.github/workflows/docs.yaml

@@ -0,0 +1,71 @@
+name: docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'src/**'
+      - 'mkdocs.yml'
+      - 'scripts/gen_api_ref.py'
+      - '.github/workflows/docs.yaml'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - 'src/**'
+      - 'mkdocs.yml'
+      - 'scripts/gen_api_ref.py'
+      - '.github/workflows/docs.yaml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install dependencies
+        run: uv sync --group docs
+
+      - name: Build documentation
+        run: uv run mkdocs build
+
+      - name: Upload artifact
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site/
+
+  deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Makefile

@@ -57,15 +57,18 @@ openapi-doc:	docs/openapi.json scripts/fix_openapi_doc.py	## Generate OpenAPI do
 	python3 scripts/fix_openapi_doc.py <  output.md > docs/openapi.md
 	rm output.md
 
-generate-documentation:	## Generate documentation
-	scripts/gen_doc.py
-
 # TODO uv migration
 requirements.txt:	pyproject.toml pdm.lock ## Generate requirements.txt file containing hashes for all non-devel packages
 	pdm export --prod --format requirements --output requirements.txt --no-extras --without evaluation
 
-doc:	## Generate documentation for developers
-	scripts/gen_doc.py
+docs-build:	## Build MkDocs documentation site
+	uv run mkdocs build
+
+docs-serve:	## Serve MkDocs documentation locally with hot-reload
+	uv run mkdocs serve
+
+docs-readmes:	## Generate README.md files in source directories
+	uv run scripts/gen_doc.py
 
 docs/config.puml:	src/models/config.py ## Generate PlantUML class diagram for configuration
 	pyreverse src/models/config.py --output puml --output-directory=docs/

docs/index.md

@@ -1,71 +1,41 @@
----
-layout: default
-nav_order: 1
----
+# Lightspeed Core Stack
 
-# Lightspeed core stack
+Lightspeed Core Stack (LCS) is an AI-powered assistant that provides answers to product questions using backend LLM services, agents, and RAG databases.
 
-About The Project
-
-Lightspeed Core Stack (LCS) is an AI powered assistant that provides answers to product questions using backend LLM services, agents, and RAG databases.
-
-![Logo](https://lightspeed-core.github.io/lightspeed-stack/logo.jpg)
+![Logo](logo.jpg)
 
 ## Overview
 
-[Architecture](https://lightspeed-core.github.io/lightspeed-stack/ARCHITECTURE.html)
-
-[Architecture diagram](https://lightspeed-core.github.io/lightspeed-stack/architecture.svg)
-
-[Getting started](https://lightspeed-core.github.io/lightspeed-stack/getting_started.html)
-
-[Authentication and Authorization](https://lightspeed-core.github.io/lightspeed-stack/auth.html)
-
-
-
-## Installation and configuration
-
-[Deployment Guide](https://lightspeed-core.github.io/lightspeed-stack/deployment_guide.html)
-
-[Linux](https://lightspeed-core.github.io/lightspeed-stack/installation_linux.html)
-
-[MacOS](https://lightspeed-core.github.io/lightspeed-stack/installation_macos.html)
-
-[Configuration](https://lightspeed-core.github.io/lightspeed-stack/config.html)
+- [Architecture](ARCHITECTURE.md)
+- [Architecture diagram](architecture.svg)
+- [Getting started](getting_started.md)
+- [Authentication and Authorization](auth.md)
 
+## Installation and Configuration
 
+- [Deployment Guide](deployment_guide.md)
+- [Linux](installation_linux.md)
+- [macOS](installation_macos.md)
+- [Configuration](config.md)
 
 ## API
 
-[OpenAPI specification](https://lightspeed-core.github.io/lightspeed-stack/openapi.html)
-
-[Conversations API](https://lightspeed-core.github.io/lightspeed-stack/conversations_api.html)
-
-[A2A [Agent-to-Agent] Protocol](https://lightspeed-core.github.io/lightspeed-stack/a2a_protocol.html)
-
-
-
+- [OpenAPI specification](openapi.md)
+- [Conversations API](conversations_api.md)
+- [A2A (Agent-to-Agent) Protocol](a2a_protocol.md)
 
 ## RAG and BYOK
 
-[RAG Configuration Guide](https://lightspeed-core.github.io/lightspeed-stack/rag_guide.html)
-
-[BYOK guide](https://lightspeed-core.github.io/lightspeed-stack/byok_guide.html)
-
-
-## Other features
-
-[Providers](https://lightspeed-core.github.io/lightspeed-stack/providers.html)
-
-[User data collection](https://lightspeed-core.github.io/lightspeed-stack/user_data_collection.html)
-
-[Database structure](https://lightspeed-core.github.io/lightspeed-stack/DB/index.html)
+- [RAG Configuration Guide](rag_guide.md)
+- [BYOK Guide](byok_guide.md)
 
+## Other Features
 
+- [Providers](providers.md)
+- [User data collection](user_data_collection.md)
+- [Database structure](DB/index.html)
 
 ## Testing
 
-[Testing](https://lightspeed-core.github.io/lightspeed-stack/testing.html)
-
-[List of e2e scenarios](https://lightspeed-core.github.io/lightspeed-stack/e2e_scenarios.html)
-
+- [Testing](testing.md)
+- [List of E2E scenarios](e2e_scenarios.md)