Skip to content

Commit c4980c1

Browse files
committed
docs: Formalize Three-Class Architectural Roadmap (Class 1 Simple, Class 2 Orchestrator, Class 3 Global Multiplier)
1 parent cbea72c commit c4980c1

2 files changed

Lines changed: 23 additions & 11 deletions

File tree

0-AI-MANIFEST.a2ml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ This is the AI manifest for **Bundle of Joy Server**. It declares:
99
- Critical invariants (rules that must NEVER be violated)
1010
- Repository structure and organization
1111

12-
## 🏰 DUAL-TRACK ARCHITECTURE (CLASS 1 vs CLASS 2)
12+
## 🏰 THREE-CLASS ARCHITECTURE (ROADMAP)
1313

14-
This repository implements a Dual-Track design to balance simplicity and scale.
14+
This repository implements a tiered design to balance simplicity, technical rigor, and global scale.
1515

1616
### **Class 1: Simple Track (Canonical)**
1717
- **Focus:** Zero-infrastructure simplicity.
@@ -25,7 +25,13 @@ This repository implements a Dual-Track design to balance simplicity and scale.
2525
- **Cartridge Pattern:** Uses core generic handlers to wrap cartridge FFI.
2626
- **Path:** `adapter/v/src/class_2_orchestrator/`.
2727

28-
**INVARIANT:** Class 2 features must NEVER damage or replace the Class 1 foundation.
28+
### **Class 3: Multiplier Track (Global)**
29+
- **Focus:** Extreme fault tolerance and mass concurrency.
30+
- **Workflow:** Extension Store proxying (Claude, ChatGPT, Mistral).
31+
- **Multiplier Pattern:** **Elixir / BEAM** piggyback unit for massive scale.
32+
- **Project:** `elixir-mcp-server` / `boj-server-gemini`.
33+
34+
**INVARIANT:** Advanced features must NEVER damage or replace the Class 1 foundation.
2935

3036
## CANONICAL LOCATIONS (UNIVERSAL RULE)
3137

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,27 @@ A genuine 'bundle of joy'.
1212
<img src="https://www.bestpractices.dev/projects/12164/badge" alt="OpenSSF Best Practices passing (115%)" />
1313
</a>
1414

15-
## 🏰 Dual-Track Architecture
15+
## 🏰 Three-Class Architecture
1616

17-
BoJ Server provides two distinct ways to interact with cartridges, catering to different needs for simplicity and scale.
17+
BoJ Server provides three distinct deployment tiers, catering to different needs for simplicity, security, and global scale.
1818

1919
### **Class 1: Simple Track (Canonical)**
2020
- **Focus:** Simplicity, local-first, zero-infrastructure.
21-
- **Workflow:** Repositories use standard GitHub Actions (`curl` triggers) to talk to the server.
22-
- **Implementation:** Each cartridge is self-contained with its own adapters.
23-
- **Best for:** Most users, quick setups, and easy debugging.
21+
- **Workflow:** Repositories use standard GitHub Actions (`curl` triggers) to talk to the server REST API.
22+
- **Implementation:** Self-contained V-lang adapters wrapping Idris2/Zig logic.
23+
- **Best for:** Personal infrastructure, solo developers, and easy debugging.
2424

2525
### **Class 2: Orchestrator Track (Advanced)**
26-
- **Focus:** Unified transport, high-performance, massive scale.
26+
- **Focus:** Secure gateways and technical orchestration.
2727
- **Workflow:** Uses secure Webhooks (HMAC-SHA256) and unified real-time gateways (MQTT/WebSockets).
28-
- **Implementation:** Core-level generic handlers located in `adapter/v/src/class_2_orchestrator/`.
29-
- **Best for:** Production environments, IoT integration, and multi-agent orchestration.
28+
- **Implementation:** Core generic handlers located in `adapter/v/src/class_2_orchestrator/`.
29+
- **Best for:** Corporate settings, VPN-backed services, and technical power users.
30+
31+
### **Class 3: Multiplier Track (Global)**
32+
- **Focus:** Extreme fault tolerance, concurrency, and mass distribution.
33+
- **Workflow:** High-performance proxying for extension stores (Google, Claude, ChatGPT, Mistral).
34+
- **Implementation:** **Elixir / BEAM** "piggyback" unit providing massive-scale process supervision.
35+
- **Best for:** Mass audiences, distributed Umoja networks, and commercial extension hosting.
3036

3137
---
3238

0 commit comments

Comments
 (0)