Watch
1
0
Fork
You've already forked souveraine
0
souveraine/saf/INDEX.md

39 lines
2.5 KiB
Markdown
Raw Normal View History

# Souveraine Architecture Framework (SAF)
> The canonical reference for every config option, every code path, and every gap.
> Kept in sync with implementation plans.
## Architecture Note: 2026-05-12 Audit
The SAF was comprehensively refreshed on 2026-05-12 to reflect ~2500 lines of new code across 12+ new modules landed over the preceding week. Major additions since the May 6 rebuild: nervous system (EventBus/CronSensor/HeartbeatHandler/EventLog), seed identity (Ed25519), credentials (OS keyring), skills system (4-tier discovery), compaction engine (4 strategies), N+25 reflection engine (full LLM tool loop), TUI chat (cockpit/schedules/portrait/presence), conversation persistence store, and the N+1 Aster subconscious pass (subconscious agent identity, ledgers, Bifrost tool loop).
## Contents
1. [Architecture Overview](architecture.md) — Core paradigm, module tree, data flow (updated 2026-05-12)
2. [Config Reference](config.md) — Every config option, default, and where it's read
3. [Module Map](modules.md) — Every source file, its state, and its dependencies (updated 2026-05-12)
4. [Module Detail: Server](server.md) — HTTP server endpoints, implementation status
5. [Consciousness System](consciousness.md) — N+1 (Aster), N+25 (Reflection), N+100 (Archivist) deep dive (updated 2026-05-12)
6. [Identity & Memory](identity.md) — Seed identity, per-agent memfs, frontmatter, ledger system (updated 2026-05-12)
7. [The Laws](laws.md) — Constitutional principles, duality, inbox nervous system, bootstrap sequence
8. [Gap Analysis](gaps.md) — Every gap, WHY it exists, and the path to fix it (updated 2026-05-12)
9. [Plan Sync](plan.md) — Implementation roadmap, synced with codebase state (updated 2026-05-12)
10. [AT Protocol Federation](atproto-federation.md) — Distributed consciousness across multiple harnesses (research)
11. [Glossary](glossary.md) — Terms, concepts, architecture decisions
## How to Read
- **New to Souveraine:** Start with [Architecture Overview](architecture.md)
- **Implementing a feature:** Read the relevant module detail + gap analysis
- **Debugging a config issue:** Read [Config Reference](config.md)
- **Planning work:** Read [Gap Analysis](gaps.md) + [Plan Sync](plan.md)
- **Adding a new module:** Read the relevant section in [Module Map](modules.md)
## Status Legend
| Symbol | Meaning |
|--------|---------|
| ✅ | Implemented and working |
| ⚠️ | Partial / stubbed / minimal implementation |
| ❌ | Not started / missing |
| 🟡 | Needs attention / known issue |