diff --git a/README.md b/README.md index 70f7566d..07846496 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@

Libraries License Runtime License - Crates - Examples + Crates + Examples FaaS Version

@@ -139,7 +139,7 @@ At c=200 concurrency, WASM **exceeds** NativeCode (25K vs 24.6K) due to dedicate | **AI Plugins** | 51 crates | LLM, RAG, Agent, embeddings, vector DB | | **Observability** | vil_log, vil_observer, vil_otel | Semantic log, dashboard, Prometheus, OpenTelemetry | -**171 crates** | **234 examples** | **20 built-in FaaS** | **13 triggers** | **30 connectors** +**172 crates** | **119 examples** | **20 built-in FaaS** | **13 triggers** | **30 connectors** ## Examples (9 Tiers) diff --git a/ROADMAP.md b/ROADMAP.md index 88531642..4ca8b225 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -2,9 +2,9 @@ > Last updated: 2026-04-03 -## Current State (v0.1.0) +## Current State (v0.4.0) -VIL ships with **102 crates** and **63 examples** covering: +VIL ships with **172 crates** and **119 examples** covering: ### Core Runtime & Compiler vil_types, vil_shm, vil_queue, vil_registry, vil_rt, vil_obs, vil_net, vil_engine, vil_tensor_shm, vil_consensus, vil_operator, vil_ir, vil_diag, vil_validate, vil_macros, vil_codegen_rust, vil_codegen_c, vil_ai_compiler diff --git a/docs/ARCHITECTURE_OVERVIEW.md b/docs/ARCHITECTURE_OVERVIEW.md index 2936811e..68f5fa5b 100644 --- a/docs/ARCHITECTURE_OVERVIEW.md +++ b/docs/ARCHITECTURE_OVERVIEW.md @@ -1,6 +1,6 @@ # VIL Architecture Overview -**142 crates** | **112 examples** | **1,425+ tests** | **12 protocols** | **3 execution modes** +**172 crates** | **119 examples** | **1,612+ tests** | **12 protocols** | **3 execution modes** **License:** MIT OR Apache-2.0 | **Repository:** [github.com/OceanOS-id/VIL](https://github.com/OceanOS-id/VIL) --- @@ -44,7 +44,7 @@ Each layer builds on the one below without modifying its contracts. --- -## 2. Crate Taxonomy (11 Layers, 142 Crates) +## 2. Crate Taxonomy (11 Layers, 172 Crates) ### Layer A: Runtime Substrate @@ -221,7 +221,7 @@ Full benchmark: [examples/BENCHMARK_REPORT.md](../examples/BENCHMARK_REPORT.md) | [vil-server Guide](./vil-server/vil-server-guide.md) | Server framework reference | | [API Reference](./vil-server/API-REFERENCE-SERVER.md) | Per-module API documentation | | [Quick Start](./QUICK_START.md) | Getting started | -| [Examples](./EXAMPLES.md) | 93 runnable examples | +| [Examples](./EXAMPLES.md) | 119 runnable examples | | [Changelog](./CHANGELOG.md) | Release history | --- diff --git a/docs/GOOD_FIRST_ISSUES.md b/docs/GOOD_FIRST_ISSUES.md index 894120e7..fc368568 100644 --- a/docs/GOOD_FIRST_ISSUES.md +++ b/docs/GOOD_FIRST_ISSUES.md @@ -30,13 +30,13 @@ These issues are designed to help new contributors get familiar with the VIL cod ### 4. Create a "Hello Pipeline" minimal example **Labels**: `good first issue`, `example` -**File**: `examples/002-hello-pipeline/` +**File**: `examples/003-basic-hello-server/` **Task**: Create the simplest possible VIL pipeline — just two nodes exchanging a message. Use Layer 1 API (`vil_sdk::http_gateway()`). -**Acceptance**: `cargo run --example hello-pipeline` produces output. +**Acceptance**: `cargo run --example 003-basic-hello-server` produces output. ### 5. Create a fan-out example **Labels**: `good first issue`, `example` -**File**: `examples/003-fanout-demo/` +**File**: `examples/046-basic-mesh-scatter-gather/` **Task**: Demonstrate one-to-many message broadcasting using VIL's Tri-Lane protocol. **Acceptance**: Shows messages being sent to multiple consumers. @@ -64,7 +64,7 @@ These issues are designed to help new contributors get familiar with the VIL cod ### 9. Add connection timeout to `HttpSourceBuilder` **Labels**: `good first issue`, `enhancement` -**File**: `crates/vil_http/src/source.rs` +**File**: `crates/vil_new_http/src/source.rs` **Task**: Add a configurable connection timeout (default 30s) to `HttpSourceBuilder` so the source doesn't hang indefinitely when the upstream is down. **Acceptance**: Builder has `.timeout(Duration)` method; connection fails fast when upstream is unreachable. @@ -78,10 +78,10 @@ These issues are designed to help new contributors get familiar with the VIL cod ## Testing -### 11. Add integration test for `vil new` templates +### 11. Add integration test for `vil init` templates **Labels**: `good first issue`, `test` **File**: `crates/vil_cli/tests/` -**Task**: Write a test that runs `vil new` for each template and verifies the generated project compiles with `cargo check`. +**Task**: Write a test that runs `vil init` for each template and verifies the generated project compiles with `cargo check`. **Acceptance**: `cargo test -p vil_cli` passes with template generation tests. ### 12. Add benchmark for SHM allocator @@ -106,11 +106,9 @@ These issues are designed to help new contributors get familiar with the VIL cod **Task**: Create a Tower Layer that rejects requests with body larger than configurable limit. Return 413 Payload Too Large. **Acceptance**: Requests exceeding limit are rejected with proper error response. -### 15. Implement `vil_db_mongodb` plugin +### 15. Implement `vil_db_mongodb` plugin ✅ DONE **Labels**: `good first issue`, `vil-server`, `database` -**File**: New crate `crates/vil_db_mongodb/` -**Task**: Implement `DbPool` trait from `vil_server_db` using the `mongodb` crate. Include connection pooling and health check. -**Acceptance**: MongoDB plugin connects, queries, and reports health via `/admin/plugins`. +**Status**: Already implemented as `vil_db_mongo` (Phase 1). No action needed — kept for historical reference. ### 16. Write benchmark: vil-server vs Actix-web **Labels**: `good first issue`, `vil-server`, `performance` diff --git a/docs/INDEX.md b/docs/INDEX.md index 2bf38d20..dbe2f547 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -1,6 +1,6 @@ # VIL Documentation -**Version:** 5.1.0 +**Version:** v0.4.0 **License:** Apache-2.0 **GitHub:** https://github.com/OceanOS-id/VIL @@ -30,25 +30,17 @@ VIL Source Code ### Just Getting Started? 1. **[Quick Start](./QUICK_START.md)** — Build your first pipeline (10 min) 2. **[Installation](./INSTALLATION.md)** — Setup for Linux, macOS, Docker -3. **[Examples](./EXAMPLES.md)** — 18 runnable examples +3. **[Examples](./EXAMPLES.md)** — 119 runnable examples ### VIL (Language) - **[VIL Concept](./vil/VIL_CONCEPT.md)** — 10 immutable design principles -- **[Developer Guide](./vil/VIL-Developer-Guide.md)** — complete language reference +- **[Developer Guide (11 parts)](./vil/001-VIL-Developer_Guide-Overview.md)** — complete language reference - **[Architecture Overview](./ARCHITECTURE_OVERVIEW.md)** — layered system design ### vil-server (Standalone) -- **[Getting Started](./tutorials/tutorial-getting-started-server.md)** — from zero to running - **[Developer Guide](./vil-server/vil-server-guide.md)** — full feature reference -- **[Production Guide](./tutorials/tutorial-production-server.md)** — Docker, Kubernetes - **[API Reference](./vil-server/API-REFERENCE-SERVER.md)** — per-module docs -### Tutorials -1. [Hello Pipeline](./tutorials/tutorial-01-hello-pipeline.md) -2. [Custom Nodes](./tutorials/tutorial-02-custom-nodes.md) -3. [Tri-Lane Deep Dive](./tutorials/tutorial-03-trilane.md) -4. [Production Deployment](./tutorials/tutorial-04-production.md) - ### Observability - **[Observer Dashboard](./vil/010-VIL-Developer_Guide-Observer-Dashboard.md)** — embedded dashboard, SLO budget, alerting, Prometheus export @@ -64,21 +56,19 @@ VIL Source Code ### Developer (Write Services) | Start Here | Then | Deep Dive | |-----------|------|-----------| -| [Quick Start](./QUICK_START.md) | [Examples](./EXAMPLES.md) | [Developer Guide](./vil/VIL-Developer-Guide.md) | +| [Quick Start](./QUICK_START.md) | [Examples](./EXAMPLES.md) | [Developer Guide (11 parts)](./vil/001-VIL-Developer_Guide-Overview.md) | ### Ops (Deploy Services) | vil-server | |-------------| | `cargo build` → run binary | -| [Production Guide](./tutorials/tutorial-production-server.md) | ### Architect (Design Systems) | Document | Focus | |----------|-------| | [VIL Concept](./vil/VIL_CONCEPT.md) | Design principles | | [Architecture](./ARCHITECTURE_OVERVIEW.md) | System layers | -| [Design Doc](../docs-deliverables/DESIGN-VX-process-oriented-server.md) | Architecture decisions | --- -**Version:** 5.1.0 | **License:** Apache-2.0 | **Tests:** 166 | **Crates:** 22+ +**Version:** v0.4.0 | **License:** Apache-2.0 | **Tests:** 1612 | **Crates:** 172 diff --git a/llm_knowledge/index.md b/llm_knowledge/index.md index 488a9793..3e988d52 100644 --- a/llm_knowledge/index.md +++ b/llm_knowledge/index.md @@ -10,7 +10,7 @@ Pick the file matching the user's question. Each file is self-contained. ### Quickstart | File | Description | Keywords | |------|-------------|----------| -| [quickstart/what-is-vil.md](quickstart/what-is-vil.md) | What VIL is, 130+ crates, 83 examples, 9 SDK languages, patterns, key types | overview, introduction, architecture, crates | +| [quickstart/what-is-vil.md](quickstart/what-is-vil.md) | What VIL is, 172 crates, 119 examples, 9 SDK languages, patterns, key types | overview, introduction, architecture, crates | | [quickstart/hello-server.md](quickstart/hello-server.md) | Minimal VilApp hello server | getting started, first server, hello world | | [quickstart/hello-pipeline.md](quickstart/hello-pipeline.md) | Minimal vil_workflow! pipeline | getting started, first pipeline, workflow |