Skip to content

chore: M1 CHANGELOG stub + DC8 reorder #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ProtocolWarden merged 2 commits into from
May 8, 2026
Merged

chore: M1 CHANGELOG stub + DC8 reorder #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
005471b
chore: add CHANGELOG.md stub (Keep-a-Changelog format)
ProtocolWarden May 8, 2026
c9fe8fd
docs: move Quick start before Architecture (DC8 ordering)
ProtocolWarden May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
56 changes: 28 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,34 @@ ExecutorRuntime).

---

## Quick Start

**Prerequisites:** Python 3.11+. No other services required for local dev/test.

```bash
# 1. Clone and install
git clone https://github.com/Velascat/SwitchBoard
cd SwitchBoard
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e ".[dev]"

# 2. Configure
cp .env.example .env
# Edit .env — see .env.example for all available variables

# 3. Start
bash scripts/run_dev.sh

# 4. Verify
bash scripts/smoke_test.sh
```

For a detailed walkthrough including verification steps and the first real request,
see **[docs/quickstart.md](docs/quickstart.md)**.

---

## Architecture

SwitchBoard is a thin policy boundary: requests come in, a lane is selected from `config/policy.yaml`, and an `ExecutionRequest` envelope routes downstream to the chosen runner. The lane catalog is fixed (see **Execution Lanes** below); cost/quality tradeoffs are config edits, not code changes. Configuration loads from `config/policy.yaml` + environment overlays — see the **Configuration** and **API** sections later for the full surface.
Expand Down Expand Up @@ -89,34 +117,6 @@ into a single, testable, hot-reloadable policy.

---

## Quick Start

**Prerequisites:** Python 3.11+. No other services required for local dev/test.

```bash
# 1. Clone and install
git clone https://github.com/Velascat/SwitchBoard
cd SwitchBoard
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate
pip install -e ".[dev]"

# 2. Configure
cp .env.example .env
# Edit .env — see .env.example for all available variables

# 3. Start
bash scripts/run_dev.sh

# 4. Verify
bash scripts/smoke_test.sh
```

For a detailed walkthrough including verification steps and the first real request,
see **[docs/quickstart.md](docs/quickstart.md)**.

---

## Configuration

| File | Purpose |
Expand Down
Loading