From 31206e8fce6ca9d60964586406e2c8aba5b52b05 Mon Sep 17 00:00:00 2001
From: acano <acturnes@mrhouston.net>
Date: Thu, 5 Mar 2026 15:16:50 +0100
Subject: [PATCH] refactor: Update project structure in README to enhance
 clarity and organization

---
 README.md | 37 ++++++++++++++++++++++++++++---------
 1 file changed, 28 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index f9605eb..c49c0b5 100644
--- a/README.md
+++ b/README.md
@@ -42,18 +42,37 @@ graph TD
 ## Project Structure
 
 ```text
-.
-├── .github/
-│   └── pull_request_template.md  # Mandatory PR checklist
-├── Dockerfile                    # Container definition for the Engine
+
 ├── README.md                     # System documentation & Dev guide
-├── CONTRIBUTING.md               # Contribution standards & policies
 ├── changelog                     # Version tracking and release history
-├── docker-compose.yaml           # Local orchestration for dev environment
-├── protos/
-│   └── brunix.proto              # Protocol Buffers: The source of truth for the API
+├── pyproject.toml                # Python project configuration
+├── Docker/
+│   ├── Dockerfile                # Container definition for the Engine
+│   ├── docker-compose.yaml       # Local orchestration for dev environment
+│   ├── requirements.txt           # Python dependencies for Docker
+│   ├── protos/
+│   │   └── brunix.proto          # Protocol Buffers: The source of truth for the API
+│   └── src/
+│       ├── graph.py              # Workflow graph orchestration
+│       ├── prompts.py            # Centralized prompt definitions
+│       ├── server.py             # gRPC Server & RAG Orchestration
+│       ├── state.py              # Shared state management
+│       └── utils/                # Utility modules
+├── ingestion/
+│   └── docs/                     # AVAP documentation chunks
+├── kubernetes/
+│   └── kubeconfig.yaml           # Kubernetes cluster configuration
+├── scripts/
+│   └── pipelines/
+│       ├── flows/                # Data processing flows
+│       └── tasks/                # Pipeline task definitions
 └── src/
-    └── server.py                 # Core Logic: gRPC Server & RAG Orchestration
+    ├── __init__.py
+    ├── config.py                 # Application configuration
+    └── utils/
+        ├── emb_factory.py        # Embedding model factory
+        ├── llm_factory.py        # LLM model factory
+        └── __init__.py
 ```
 
 ---