From c2e692797892a8d6223974774d30a2f12984bf6f Mon Sep 17 00:00:00 2001
From: lebaudantoine <lebaud.antoine131@gmail.com>
Date: Wed, 17 Sep 2025 22:15:15 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D(summary)=20add=20minimal=20README?=
 =?UTF-8?q?=20for=20dev=20experience?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Basic README with developer setup info. Will be expanded
with more details in future commits.
---
 src/summary/README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 src/summary/README.md

diff --git a/src/summary/README.md b/src/summary/README.md
new file mode 100644
index 00000000..3cea22ce
--- /dev/null
+++ b/src/summary/README.md
@@ -0,0 +1,32 @@
+# Experimental Stack
+
+This is an experimental part of the stack.  It currently lacks proper observability, unit tests, and other production-grade features. This serves as the base for AI features in Visio.
+
+## Usage
+
+From the root of the project:
+
+```sh
+make bootstrap
+```
+
+Configure your env values in `env.d/summary` to properly set up WhisperX and the LLM API you will call.
+
+```sh
+make run
+```
+
+When the stack is up, configure the MinIO webhook
+*(TODO: add this step to `make bootstrap`)*
+
+```sh
+make minio-webhook-setup
+```
+
+If you want to develop on the Celery workers with hot reloading, run:
+
+```sh
+docker compose watch celery-summary-transcribe celery-summary-summarize
+```
+
+Celery workers will hot reload on any change.