Files
chorus-services/planning and reports/PROJECT_PLAN.md
tony 4ed167e734 Update branding assets and deployment configurations
- Enhanced moebius ring logo design in Blender
- Updated Docker Compose for website-only deployment with improved config
- Enhanced teaser layout with updated branding integration
- Added installation and setup documentation
- Consolidated planning and reports documentation
- Updated gitignore to exclude Next.js build artifacts and archives

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-08-27 07:45:08 +10:00

136 lines
7.5 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# CHORUS Services Development Project Plan
## Executive Summary
CHORUS Services delivers enterprise-grade distributed AI orchestration through sophisticated architecture designed to eliminate context loss, reduce hallucinations, and enable seamless multi-agent collaboration. The platform employs minimalist design principles with sophisticated functionality, utilizing Ant Design 5+ for user interface implementation.
## Technology Architecture
**Frontend Architecture**: React (Next.js 13+), Ant Design 5+ (sophisticated component theming), Framer Motion (elegant animations), CSS-in-JS with @ant-design/cssinjs
**Backend Services**: FastAPI (Python) for API architecture; Node.js for orchestration components
**Peer-to-Peer Coordination**: libp2p (Go/Rust) for BZZZ distributed agent networks
**Context Management**: SLURP context architecture (Python/FastAPI with Postgres/SQLite)
**Distributed Reasoning**: HMMM collaborative decision service
**Performance Optimization**: COOEE feedback system (Python/FastAPI with integrated learning)
**Workflow Orchestration**: WHOOSH coordination engine (seamless integration with all components)
**Audit Architecture**: Hypercore immutable event logging (Node.js/Rust)
**Network Security**: Tailscale (peer-to-peer overlay), Cloudflare (edge/proxy)
**Infrastructure Automation**: Ansible deployment management
**Model Integration**: Ollama hosting architecture, BZZZ container orchestration
## Platform Components
| Component | Service Name | Function | Architecture Focus |
|-----------|--------------|----------|-------------------|
| Orchestration | WHOOSH | Workflow coordination hub | Enterprise task distribution |
| Peer Communication | BZZZ | Distributed agent mesh | Resilient coordination network |
| Collaborative Reasoning | HMMM | Decision consensus logic | Sophisticated verification protocols |
| Context Management | SLURP | Knowledge curation | Intelligent information architecture |
| Performance Feedback | COOEE | Learning optimization | Continuous improvement system |
| Audit Logging | Hypercore Log | Immutable event tracking | Enterprise compliance architecture |
## Development Components and Feature Architecture
| Code | Module | Feature Name | Description |
|--------------|-----------------|--------------------------|-------------------------------------------------------------------|
| WHOOSH.01 | WHOOSH | AgentRegistry | Register/configure agents; display real-time health/status |
| WHOOSH.02 | WHOOSH | WorkflowEditor | Visual workflow editor (Ant Design UI, React Flow integration) |
| BZZZ.01 | BZZZ | MeshNetworking | Mesh node join, peer discovery (libp2p, Tailscale) |
| BZZZ.02 | BZZZ | P2PTaskFlow | Event and coordination message system |
| HMMM.01 | HMMM | MetaDiscussion | Structured agent reasoning and consensus before action |
| SLURP.01 | SLURP | CuratorEngine | Event classification, context promotion, RL signals |
| SLURP.02 | SLURP | StorageAPI | Context archive, Postgres/SQLite integration |
| COOEE.01 | COOEE | FeedbackCollector | REST API + message bus for feedback ingestion |
| COOEE.02 | COOEE | RLPolicyAdapter | RL-based tuning of promotion/curation rules |
| LOG.01 | Hypercore Log | EventIngestion | Append-only event logging (Node.js/Rust) |
| LOG.02 | Hypercore Log | LogExplorer | UI for browsing/auditing logs (React + Ant Design table/views) |
## Implementation Architecture
### Ant Design UI System
- Use Ant Designs dark mode theme as base, customized for CHORUS colors (#1a1a1a, #007aff, #30d158, #f2f2f7)
- All buttons, cards, tables, and forms should use the Ant Design system for accessibility and consistency
- Use Framer Motion for scroll-based/premier animations (parallax, reveals, metric counter-ups)
- Network diagrams, logs, and workflow flows: combine Ant Design components with (if needed) custom SVG/Canvas
### Backend/APIs
- New endpoint structure should use updated nomenclature: `api/chorus/agent`, `api/chorus/whoosh/`, etc.
- API docs generated via FastAPIs native OpenAPI/Swagger
### BZZZ Nodes & Tailscale
- All peer discovery and pubsub must use BZZZ and reference BZZZ in code/docs (not Bzzz or any bee analogies)
- Tailscale for securing cross-cloud/cluster comms; internal services should **never be internet-facing**
### Context/RL
- SLURPs curation logic should be configurable via Ant Design modal/settings UI (YAML upload + real-time tuning)
- COOEEs feedback features have prominent performance dashboards (Ant Progress, Trend, and Gauge components)
### Logging
- All logs and traces to be named **CHORUS Event Log** or **Audit Log** in UI/copy
- Include direct links from module UIs to related event log entries for traceability
## 6. Sprint Board / Waterfall Plan (Phased with New Names)
### Phase 1: Infra & Scaffolding
- Initial WHOOSH orchestration deployment (UI + backend structure)
- BZZZ mesh networking POC via Tailscale in local/lab
- SLURP curation engine v0 (basic event filtering)
- LOG module: event ingestion scaffolding
### Phase 2: Core Intelligence Flows
- BZZZ agent integration and mesh-wide task routing
- HMMM pre-task consensus/reasoning mechanism (with meta-discussion UI)
- COOEE feedback API and RL signal loop (basic metric view)
- SLURP role-based context curation (UI for manual tuning/testing)
### Phase 3: UX/Dashboards
- Ant Design-powered dashboards for:
- Real-time agent status (WHOOSH.01)
- Context curation health and history (SLURP.01)
- Feedback analytics (COOEE.01)
- Log explorer with filters (LOG.02)
- Public landing page: focus on what CHORUS **achieves** technologically
### Phase 4: Integration & Security
- Harden all BZZZ/WHOOSH communications with Tailscale routing
- Cloudflare Zero Trust on all public dashboards/APIs
- OAuth2/JWT integration for RBAC across the UI
### Phase 5: Productionization
- CI/CD pipelines with automated tests and deployments
- Automated backup to Backblaze/Scaleway
- Cost/performance optimization (monitoring, log rotation, model/agent scaling)
## 7. Key Team Roles
- **Frontend Developer (Ant Design + React):** UI/UX implementation, parallax and animation integration, technical dashboard builds
- **Backend/API Developer (Python/FastAPI):** REST API, orchestration logic, BZZZ bridge, SLURP curation implementation
- **DevOps/Cloud Engineer:** Ansible, Tailscale, AWS/Hetzner integration, security hardening, storage automation
- **ML/Feedback Specialist:** COOEE RL policy, feedback analysis, SLURP rule optimization, trace/data QA
- **Documentation/QA Engineer:** API/SDK docs, audit storybook, minimization of jargon, clear modular handover
## 8. Launch Checklist
- [ ] All modules rebranded in UI, code, and docs (WHOOSH, BZZZ, HMMM, SLURP, COOEE, CHORUS Event Log)
- [ ] Ant Design v5+ and theme applied across UI, with Framer Motion for animation
- [ ] Metrics dashboards highlight context retention, hallucination reduction, and cross-agent collaboration rates
- [ ] No residual bee/honeycomb/hexagon branding or component naming
- [ ] Landing page language and imagery emphasize technological innovation and enterprise readiness
- [ ] Automated security, monitoring, and backup pipelines in place