| title | AllSource Documentation |
|---|---|
| status | CURRENT |
| last_updated | 2026-02-08 |
Welcome to the AllSource documentation. This hub provides comprehensive guides, architecture documentation, and operational resources for the AllSource event sourcing platform.
| Link | Description | |
|---|---|---|
| 🚀 | Quick Start | Get up and running in minutes |
| 📖 | Architecture | Clean architecture principles |
| ⚡ | Performance | Optimization strategies |
| 🔒 | Security | Multi-tenant security model |
| 🛠️ | Quality Gates | CI/CD quality standards |
| 🗺️ | Roadmap | Future plans and progress |
February 2026
- Updated documentation hub with modern navigation
- Consolidated quality gates documentation
November 2025
- Added multi-tenant architecture security documentation
- Quality gates implementation and enforcement
- Critical bug fixes documented
October 2025
- Clean Architecture refactoring complete (Phase 1.5)
- Performance optimization guide published
- Query Service roadmap established
| Marker | Status | Meaning |
|---|---|---|
| ✅ | CURRENT | Active, up-to-date documentation |
| NEEDS_REVIEW | May be outdated, review before use | |
| 📦 | ARCHIVED | Historical reference, superseded by newer docs |
For new users looking to understand and run AllSource.
| Document | Description | Status |
|---|---|---|
| Quick Start | Installation and first run | ✅ |
| Demo Walkthrough | Hands-on demonstration | ✅ |
| MCP Server Setup | Claude Desktop integration | ✅ |
For understanding the system architecture and design decisions.
| Document | Description | Status |
|---|---|---|
| Clean Architecture | Layered architecture guide | ✅ |
| SOLID Principles | Design principles applied | ✅ |
| Tenant Architecture | Multi-tenancy and isolation | ✅ |
| Event Store Features | Core event sourcing capabilities | ✅ |
| Architecture Optimization | System-level optimizations | ✅ |
How-to documentation for common tasks.
| Document | Description | Status |
|---|---|---|
| WebSocket Configuration | Real-time event streaming setup | ✅ |
| Release Guide | Create releases with make release |
✅ |
| Quality Gates Setup | Configure CI/CD quality checks | ✅ |
| Branch Protection | Git workflow protection | ✅ |
| MCP Demo Script | MCP demonstration walkthrough | ✅ |
| MCP Quick Reference | MCP tool reference card | ✅ |
| Claude Code Skills | Automated testing, release, and diagnostics skills | ✅ |
Developer documentation for service integration.
| Service | README | Details |
|---|---|---|
| Rust Core | apps/core | Event sourcing engine |
| Control Plane | apps/control-plane | Cluster management (Go) |
| Query Service | apps/query-service | Read-side queries (Elixir) |
| MCP Server | apps/mcp-server | Model Context Protocol |
| Web App | apps/web | Web interface |
For DevOps and platform engineers.
| Document | Description | Status |
|---|---|---|
| Docker Deployment | Container images and configuration | ✅ |
| Quality Gates | CI/CD enforcement standards | ✅ |
| Performance Guide | Optimization and tuning | ✅ |
| Docker Images | Container configuration | ✅ |
| Troubleshooting | Common issues and solutions | ✅ |
| Test Coverage Plan | Control plane testing | ✅ |
| Document | Description | Status |
|---|---|---|
| Comprehensive Roadmap | v1.0 to v2.0 vision | ✅ |
| Query Service Roadmap | Query service evolution | ✅ |
| MCP v2 Enhancements | MCP protocol improvements | ✅ |
| Vector Embedding Design | Future AI/ML integration | ✅ |
| LanceDB Comparison | Technology comparison | ✅ |
Historical documentation preserved for reference. Each archived document notes what superseded it.
| Archived Document | Superseded By | Date |
|---|---|---|
archive/2025-10-22_CLEAN_ARCHITECTURE_FULL.md |
current/CLEAN_ARCHITECTURE.md | 2025-10-22 |
archive/2025-10-22_SOLID_PRINCIPLES_FULL.md |
current/SOLID_PRINCIPLES.md | 2025-10-22 |
archive/2025-10-22_PERFORMANCE_FULL.md |
current/PERFORMANCE.md | 2025-10-22 |
archive/2025-11-04/ARCHITECTURE_OPTIMIZATION_v1.md |
current/ARCHITECTURE_OPTIMIZATION.md | 2025-11-04 |
archive/2025-11-04/QUERY_SERVICE_ROADMAP_v1.md |
roadmaps/query-service-roadmap.md | 2025-11-04 |
archive/2025-10-21_ROADMAP.md |
roadmaps/2025-10-22_COMPREHENSIVE_ROADMAP.md | 2025-10-22 |
| Directory | Contents |
|---|---|
| archive/apps-core-phases/ | Core app refactoring phases (Phase 1-5) |
| archive/2025-11-04/ | November 2025 refactoring documentation |
| archive/2025-11-03-marketing/ | Marketing materials drafts |
| archive/2024-11-03/ | Migration documentation |
docs/
├── current/ # ✅ Active documentation
├── archive/ # 📦 Historical documents
├── guides/ # How-to guides
│ └── mcp-server/ # MCP-specific guides
├── roadmaps/ # Planning and vision
├── operations/ # Operational guides
├── testing/ # Test plans and coverage
├── marketing/ # Marketing materials
└── x402/ # X402 protocol documentation
- Timestamped:
YYYY-MM-DD_FILENAME.md - Current: Descriptive name without timestamp
All documents should include a status in their frontmatter or header:
status: CURRENT- Actively maintainedstatus: NEEDS_REVIEW- May need updatesstatus: ARCHIVED- Historical only
Use relative paths for internal links:
[Architecture Guide](./current/CLEAN_ARCHITECTURE.md)
[Core README](../apps/core/README.md)- Creating: Place new docs in the appropriate directory and update this index
- Updating: Update the
last_updateddate in frontmatter - Archiving: Move to
archive/with timestamp, update supersession reference above - Questions: Create an issue with
[docs]prefix
Navigation: Repository Home | Current Docs | Guides | Roadmaps | Archive