diff --git a/docs/quickstart/README.md b/docs/quickstart/README.md index 10ff314..c706899 100644 --- a/docs/quickstart/README.md +++ b/docs/quickstart/README.md @@ -1,13 +1,17 @@ -# Getting Started with Asya🎭 +# Getting Started with Asya🎭 Locally -**5-minute guide to running Asya🎭 locally** +**Core idea**: Build multi-step AI/ML pipelines where each step deployed as an [actor](https://en.wikipedia.org/wiki/Actor_model) and scales independently. No infrastructure code in your code - just pure Python. -Asya🎭 is a Kubernetes-native queue-based actor framework for AI/ML workloads. Write pure Python functions, deploy them as actors, and let Asya🎭 handle queues, routing, and autoscaling (0→N pods based on queue depth). +## What You'll Learn -**Core idea**: Build multi-step AI/ML pipelines where each step scales independently. No infrastructure code in your handlers - just pure Python. +- Create a Kind cluster to run Kubernetes locally in Docker, and install KEDA for autoscaling +- Deploy the Asya operator with SQS transport (running via LocalStack) +- Build and deploy your first actor with scale-to-zero capability +- Test autoscaling by sending messages to actor queues +- Optionally add S3 storage, MCP gateway, and Prometheus monitoring ## Prerequisites diff --git a/docs/quickstart/for-data-scientists.md b/docs/quickstart/for-data-scientists.md index 9d69367..bb72ce2 100644 --- a/docs/quickstart/for-data-scientists.md +++ b/docs/quickstart/for-data-scientists.md @@ -2,6 +2,14 @@ Build and deploy your first Asya actor. +## What You'll Learn + +- Write pure Python handlers (functions or classes) for ML pipelines +- Test handlers locally and package them in Docker images +- Deploy actors using AsyncActor CRDs with autoscaling +- Use Flow DSL to build multi-step pipelines with conditional routing +- Handle dynamic routing with envelope mode for AI agents + ## Overview As a data scientist, you focus on writing pure Python functions. Asya handles infrastructure, routing, scaling, and monitoring. diff --git a/docs/quickstart/for-platform-engineers.md b/docs/quickstart/for-platform-engineers.md index b58ef5f..192c72d 100644 --- a/docs/quickstart/for-platform-engineers.md +++ b/docs/quickstart/for-platform-engineers.md @@ -2,6 +2,14 @@ Deploy and manage Asya🎭 infrastructure. +## What You'll Learn + +- Install and configure Asya operator with transports (SQS/RabbitMQ) +- Deploy gateway and crew actors for pipeline completion +- Support data science teams with templates and IAM configuration +- Set up monitoring with Prometheus and troubleshoot common issues +- Optimize scaling and costs for production workloads + ## Overview As platform engineer, you: diff --git a/mkdocs.yml b/mkdocs.yml index 747540d..dd089f4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,7 +27,7 @@ nav: - GETTING STARTED: - Motivation: motivation.md - Concepts: concepts.md - - Quickstart: quickstart/README.md + - Getting Started: quickstart/README.md - For Data Scientists 🧑‍🔬: quickstart/for-data-scientists.md - For Platform Engineers ⚙️: quickstart/for-platform-engineers.md - INSTALLATION: