docs: add docs folder (architecture, developer, usage); update README; wire probe TTL cache + concurrency notes into docs
This commit is contained in:
26
docs/developer/setup.md
Normal file
26
docs/developer/setup.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Developer Setup
|
||||
|
||||
## Prerequisites
|
||||
- Rust toolchain (stable)
|
||||
- Node.js (LTS) for control/ui
|
||||
- Docker (optional) for local stack
|
||||
|
||||
## Build
|
||||
```bash
|
||||
cargo build
|
||||
cd control/ui && npm ci && npm run build
|
||||
```
|
||||
|
||||
## Workspace Verification
|
||||
```bash
|
||||
cargo fmt --check
|
||||
cargo clippy --workspace --all-targets -- -D warnings
|
||||
cargo test --workspace
|
||||
cd control/ui && npm ci && npm run lint && npm run typecheck && npm run test && npm run build
|
||||
```
|
||||
|
||||
## Environment
|
||||
- Gateway: routing config using file or KV
|
||||
- Projection: PROJECTION_GRPC_ADDR
|
||||
- Runner: RUNNER_GRPC_ADDR
|
||||
- NATS: URLs via service-specific settings
|
||||
27
docs/developer/testing.md
Normal file
27
docs/developer/testing.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# Testing
|
||||
|
||||
## Unit and Integration
|
||||
```bash
|
||||
cargo test --workspace
|
||||
```
|
||||
|
||||
## Gated Tests (require external services)
|
||||
- Runner NATS:
|
||||
```bash
|
||||
RUNNER_TEST_NATS_URL=nats://127.0.0.1:4222 cargo test -p runner -- --ignored
|
||||
```
|
||||
- Projection NATS:
|
||||
```bash
|
||||
PROJECTION_TEST_NATS_URL=nats://127.0.0.1:4222 cargo test -p projection -- --ignored
|
||||
```
|
||||
- Docker-based gates:
|
||||
```bash
|
||||
cargo test -p gateway -- --ignored
|
||||
```
|
||||
|
||||
## Control UI
|
||||
```bash
|
||||
cd control/ui
|
||||
npm ci
|
||||
npm run test
|
||||
```
|
||||
Reference in New Issue
Block a user