Arch diagram + llama stack integration diagram

Author: tisnik

README.md

@@ -6,12 +6,14 @@
 [![License](https://img.shields.io/badge/license-Apache-blue)](https://github.com/lightspeed-core/lightspeed-stack/blob/main/LICENSE)
 [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/)
 
-Lightspeed Core Stack (LCS) is an AI powered assistant that provides answers to product questions using backend LLM services, agents, and RAG databases.
+Lightspeed Core Stack (LCS) is an AI-powered assistant that provides answers to product questions using backend LLM services, agents, and RAG databases.
 
 
 <!-- vim-markdown-toc GFM -->
 
-* [Prerequisities](#prerequisities)
+* [Architecture](#architecture)
+    * [Integration with Llama Stack](#integration-with-llama-stack)
+* [Prerequisites](#prerequisites)
 * [Installation](#installation)
 * [Configuration](#configuration)
     * [Llama Stack as separate server](#llama-stack-as-separate-server)
@@ -33,10 +35,30 @@ Lightspeed Core Stack (LCS) is an AI powered assistant that provides answers to
     * [Utility to generate OpenAPI schema](#utility-to-generate-openapi-schema)
         * [Path](#path)
         * [Usage](#usage-1)
+    * [Data Collector Service](#data-collector-service)
+        * [Features](#features)
+        * [Configuration](#configuration-1)
+        * [Running the Service](#running-the-service)
 
 <!-- vim-markdown-toc -->
 
-# Prerequisities
+
+
+# Architecture
+
+Overall architecture with all main parts is displayed below:
+
+![Architecture diagram](docs/architecture.png)
+
+Lightspeed Core Stack is based on the FastAPI framework (Uvicorn). The service is split into several parts described below.
+
+## Integration with Llama Stack
+
+![Integration with Llama Stack](docs/core2llama-stack_interface.png)
+
+
+
+# Prerequisites
 
 * Python 3.12, or 3.13
     - please note that currently Python 3.14 is not officially supported
@@ -194,8 +216,14 @@ Container images are built for the following platforms:
 1. `linux/amd64` - main platform for deployment
 1. `linux/arm64`- Mac users with M1/M2/M3 CPUs
 
+
+
 # Endpoints
 
+## OpenAPI specification
+
+* [Generated OpenAPI specification](docs/openapi.json).
+
 The service provides health check endpoints that can be used for monitoring, load balancing, and orchestration systems like Kubernetes.
 
 ## Readiness Endpoint
@@ -351,4 +379,4 @@ uv run src/lightspeed_stack.py --data-collector
 
 # Using Make target
 make run-data-collector
-```
+```

docs/installation_linux.md

@@ -1,6 +1,6 @@
 # Lightspeed Core Stack installation on Linux
 
-## Prerequisities
+## Prerequisites
 
 - git
 - Python 3.12 or 3.13
@@ -15,3 +15,5 @@
 1. `cd service`
 1. `uv info` -- should return no error
 1. `uv install`
+
+Note: `pip` installs the `uv` binary into ~/.local/bin, which is often missing from `$PATH` on fresh distributions. If the `uv` command is not found, please check if `$PATH` environment variable is set correctly.

docs/installation_macos.md

@@ -1,6 +1,6 @@
-# Lightspeed Core Stack installation on MacOS
+# Lightspeed Core Stack installation on macOS
 
-## Prerequisities
+## Prerequisites
 
 - brew
 - git