README.md

Slice Documentation Index

Welcome to the documentation hub for Slice (v0.10.12), a zero-trust JavaScript and TypeScript runtime built in Rust for multi-tenant edge services, SaaS plugin engines, and AI agent sandboxes.

Documentation is organized into four tracks depending on what you are building:

Track	Audience	Entrypoint
1. Developer Handbook (docs/general/)	JS/TS application developers, DevOps, and Rust embedders	docs/general/00_index.md
2. Framework & Tooling Guides (docs/guides/)	End-to-end recipes for web frameworks, IDE setup, and WebAssembly	docs/guides/README.md
3. API Compatibility Matrix	Supported WinterTC Web APIs, node:* modules, and Slice.* globals	docs/general/COMPATIBILITY.md
4. Architecture & Crate Internals (docs/system/)	Runtime contributors and systems engineers	docs/system/00_index.md

---

1. User & Developer Handbook (docs/general/)

• 00: Handbook Overview & Common Workflows
• 01: Getting Started, Configuration & Complete CLI Reference - Install scripts, slice init, slice.toml, inline @slice-* directives, SLICE_* env vars, and all CLI commands/flags.
• 02: Execution Engine & Tiers (slice-engine) - Precompiled SLICEBC bytecode, --warm isolate pooling, TypeScript type-guided optimizations, and Tier-0/Tier-1/Tier-2 modes.
• 03: Zero-Stat CAS Bundler & Standalone Binaries (slice-cas) - slice pack, slice compile, static asset embedding (--static), and slice inspect.
• 04: Security Architecture: OCap, SES, Fuel & DLP (slice-sandbox) - File/network/env/exec capability rules, CPU fuel and memory cages, SSRF blocking, and outbound secret redaction.
• 05: HTTP Edge Server, WinterTC APIs & Sharded KV (slice serve) - Multi-worker HTTP/1.1 keep-alive, TLS 1.3, SSE, WebSockets, Slice.kv, and --tenant-dir hot-swapping.
• 06: AI Agent Sandboxes, < 5 us Checkpoints & MCP (slice mcp) - Slice.evalSandbox(), Slice.checkpoint() / Slice.restore(), deterministic replay, and stdio MCP integration.
• 07: Node.js Compatibility (node:*), Intrinsics & NPM Packages - Built-in node:* modules (fs, crypto, stream, http, async_hooks, zlib, worker_threads), Buffer, and migration recipes.
• 08: Kernel Completion Rings (slice-io) & Rust Embedding - Linux io_uring / Windows IOCP reactor and embedding SliceIsolate inside Rust host applications.
• 09: Time-Travel Testing (slice test) & Docker Benchmark Suite - Writing tests with automatic < 5 us VFS+KV rollback and running the reproducible 33-workload benchmark suite.
• Runtime Compatibility Matrix (COMPATIBILITY.md) - Reference table of WinterTC standards, node:* APIs, Buffer, and Slice.* runtime extensions.

---

2. Framework & Tooling Guides (docs/guides/)

• Guides Overview
• Guide 01: Hono (v4), UnJS/Nitro & SvelteKit (v3) Microservices
• Guide 02: TypeScript IDE Setup (slice.d.ts), Linting & WebAssembly

---

3. System Architecture & Internals (docs/system/)

• 00: System Architecture Overview & Crate Map
• 01: slice-cas - Zero-Stat CAS Archive, Oxc Compiler & Linker
• 02: slice-engine - Bytecode Pipeline, Prelude Shards & Native Intrinsics
• 03: slice-sandbox - 5-Ring OCap Compartments, Dynamic SES & Hardware MPK
• 04: Networking, WinterTC Web Platform & Event Loop
• 05: Pure-Rust WebAssembly (wasmi), Workers & Kernel I/O
• 06: Sharded Edge KV, Copy-on-Write Checkpoints & MCP Server
• Vendored boa_engine Patch Specification (SLICE_PATCH.md)

---

4. Benchmarks & Verification Suites (tests/)

• Latest Verified 33-Workload Benchmark Report (tests/reports/latest.md)
• 24 Production Application Suites (tests/README.md)
• Full-Stack Framework Suites (tests/frameworks/README.md) - Hono v4, itty-router + UnJS, Express/Polka node:http, and SvelteKit 3 + Svelte 5 SSR.
• Interactive Case Studies & Visual Cockpit (tests/case_studies/README.md) - Tree-of-Thought SRE agent, MCP code-mode orchestrator, multi-tenant SaaS plugin mesh, Wasm CDR pipeline, and payment saga chaos fuzzer.