bashizip · bashizip · Dec 6, 2025 · Dec 6, 2025 · Dec 6, 2025 · Dec 6, 2025
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,54 @@
+# Abada Engine Documentation
+
+Welcome to the Abada Engine documentation. This documentation is organized to help you quickly find the information you need, whether you are an architect, developer, or operator.
+
+## 📚 Table of Contents
+
+### 🏗️ Architecture
+
+High-level design and architectural decisions.
+
+- [Overview](architecture/overview.md) - The big picture of Abada Engine's architecture and deployment.
+- [Authentication Service](architecture/auth-service.md) - How authentication and authorization work.
+- [Event Delivery](architecture/event-delivery.md) - Mechanics of event processing and delivery.
+- [SPI Design](architecture/spi-design.md) - Service Provider Interface design for extensibility.
+- [Event-Based Gateways](architecture/event-based-gateways-design.md) - Design of event-based gateways.
+
+### 🚀 Features
+
+Detailed guides on specific engine features.
+
+- [Process Variables](features/process-variables.md) - Handling data within processes.
+- [Service Tasks](features/service-tasks.md) - Implementing and using service tasks.
+- [Exclusive Gateway](features/exclusive-gateway.md) - Logic and usage of exclusive gateways.
+- [Persistence](features/persistence.md) - How data is stored and managed.
+- [Kitchen Sink Process](features/kitchen-sink-process.md) - A comprehensive example process demonstrating various features.
+
+### 🛠️ Operations
+
+Guides for deploying, monitoring, and managing the engine.
+
+- [Docker Deployment](operations/docker-deployment.md) - Deploying Abada Engine using Docker.
+- [Docker Build Strategy](operations/docker-build-strategy.md) - How container images are built.
+- [Observability](operations/observability.md) - Monitoring, metrics, tracing, and logging.
+- [Loki Integration](operations/loki-integration.md) - Setting up log aggregation with Loki.
+- [Sample Data Generator](operations/sample-data-generator.md) - Generating test data for development.
+
+### 💻 Development
+
+Resources for developers building on or contributing to Abada Engine.
+
+- [API Documentation](development/api.md) - REST API reference.
+- [Frontend Guide](development/frontend-guide.md) - Guide for frontend development.
+- [Orun App Specification](development/orun-app-spec.md) - Specifications for the Orun application.
+- [Project Configuration](development/project-config.md) - Review of project configuration settings.
+- [Roadmap](development/roadmap.md) - Future plans and upcoming features.
+
+### 📝 Release Notes
+
+History of changes and updates.
+
+- [Release Notes](release-notes/) - Directory containing release notes for all versions.
+
+---
+*Documentation structure organized for clarity and ease of navigation.*
diff --git a/docs/auth-service-archictecture.md → docs/architecture/auth-service.md b/docs/auth-service-archictecture.md → docs/architecture/auth-service.md
diff --git a/docs/event-based-gateways-design.md → ...chitecture/event-based-gateways-design.md b/docs/event-based-gateways-design.md → ...chitecture/event-based-gateways-design.md
diff --git a/docs/event-delivery-mechanics.md → docs/architecture/event-delivery.md b/docs/event-delivery-mechanics.md → docs/architecture/event-delivery.md
diff --git a/docs/architecture-and-deployment-guide.md → docs/architecture/overview.md b/docs/architecture-and-deployment-guide.md → docs/architecture/overview.md
diff --git a/docs/spi-design.md → docs/architecture/spi-design.md b/docs/spi-design.md → docs/architecture/spi-design.md
diff --git a/docs/abada_architecture_doc.md → docs/archive/abada_architecture_doc.md b/docs/abada_architecture_doc.md → docs/archive/abada_architecture_doc.md
diff --git a/docs/docker-deployment-plan.md → docs/archive/docker-deployment-plan.md b/docs/docker-deployment-plan.md → docs/archive/docker-deployment-plan.md
diff --git a/docs/sample-data-generator-summary.md → .../archive/sample-data-generator-summary.md b/docs/sample-data-generator-summary.md → .../archive/sample-data-generator-summary.md
diff --git a/docs/service-task-design.md → docs/archive/service-task-design.md b/docs/service-task-design.md → docs/archive/service-task-design.md
diff --git a/docs/telemetry-implementation-plan.md → .../archive/telemetry-implementation-plan.md b/docs/telemetry-implementation-plan.md → .../archive/telemetry-implementation-plan.md
diff --git a/docs/api-documentation.md → docs/development/api.md b/docs/api-documentation.md → docs/development/api.md
diff --git a/docs/frontend-development-prompt.md → docs/development/frontend-guide.md b/docs/frontend-development-prompt.md → docs/development/frontend-guide.md
diff --git a/docs/orun-app-specification.md → docs/development/orun-app-spec.md b/docs/orun-app-specification.md → docs/development/orun-app-spec.md
diff --git a/docs/project-configuration-review.md → docs/development/project-config.md b/docs/project-configuration-review.md → docs/development/project-config.md
diff --git a/docs/roadmap-to-beta.md → docs/development/roadmap.md b/docs/roadmap-to-beta.md → docs/development/roadmap.md
diff --git a/docs/exclusive-gateway.md → docs/features/exclusive-gateway.md b/docs/exclusive-gateway.md → docs/features/exclusive-gateway.md
diff --git a/docs/kitchen-sink-process.md → docs/features/kitchen-sink-process.md b/docs/kitchen-sink-process.md → docs/features/kitchen-sink-process.md
diff --git a/docs/persistence.md → docs/features/persistence.md b/docs/persistence.md → docs/features/persistence.md
diff --git a/docs/process-variables.md → docs/features/process-variables.md b/docs/process-variables.md → docs/features/process-variables.md
diff --git a/docs/service-tasks-impl.md → docs/features/service-tasks.md b/docs/service-tasks-impl.md → docs/features/service-tasks.md
diff --git a/docs/observability-implementation.md b/docs/observability-implementation.md
diff --git a/docs/docker-build-strategy.md → docs/operations/docker-build-strategy.md b/docs/docker-build-strategy.md → docs/operations/docker-build-strategy.md
diff --git a/docs/docker-deployment.md → docs/operations/docker-deployment.md b/docs/docker-deployment.md → docs/operations/docker-deployment.md
diff --git a/docs/loki-integration-walkthrough.md → docs/operations/loki-integration.md b/docs/loki-integration-walkthrough.md → docs/operations/loki-integration.md