nexus/.planning/REQUIREMENTS.md
2026-04-04 11:24:04 +00:00

140 lines
6.7 KiB
Markdown

# Requirements: Nexus v1.7 — Content Generation
**Defined:** 2026-04-04
**Core Value:** A fresh onboard asks for ONE thing (root directory), auto-creates PM + Engineer agents, and drops you in the dashboard — no company names, missions, or corporate language anywhere.
## v1.7 Requirements
Requirements for Content Generation milestone. Each maps to roadmap phases.
### Infrastructure
- [ ] **INFRA-01**: System processes content generation jobs asynchronously with queued → running → done/failed lifecycle
- [ ] **INFRA-02**: System pushes job progress updates via SSE to connected clients
- [ ] **INFRA-03**: Generated content stored in namespaced storage without size restrictions blocking video/images
- [ ] **INFRA-04**: All generated content tracked in database with source conversation linkage
### Diagram Generation
- [ ] **DIAG-01**: User can generate diagrams from natural language description
- [ ] **DIAG-02**: System renders Mermaid syntax to SVG and PNG formats
- [ ] **DIAG-03**: User can view and edit the Mermaid source for refinement
- [ ] **DIAG-04**: System supports architecture, flowchart, ERD, sequence, and mind map diagram types
- [ ] **DIAG-05**: Mermaid rendering enforces strict security level to prevent XSS
### Theme & Palette
- [ ] **THEME-01**: User can pick a seed color and receive a complete palette (background, surface, overlay, text, accents)
- [ ] **THEME-02**: System generates palette in OKLCH color space with Catppuccin-style naming
- [ ] **THEME-03**: System validates WCAG AA contrast for all foreground/background pairs
- [ ] **THEME-04**: User can preview Nexus UI with the generated palette live
- [ ] **THEME-05**: User can export palette as CSS custom properties, Tailwind config, VS Code theme, or JSON
- [ ] **THEME-06**: System generates dark and light variants from single seed color
- [ ] **THEME-07**: User can apply generated theme to their Nexus instance in one click
### Document Generation
- [ ] **DOC-01**: User can generate formatted PDF reports from conversation content
- [ ] **DOC-02**: User can generate invoices and contracts from templates
- [ ] **DOC-03**: User can generate one-pagers and API documentation
### Icon Generation
- [ ] **ICON-01**: User can generate SVG icons from a text description
- [ ] **ICON-02**: System produces icon sets with consistent visual style
- [ ] **ICON-03**: User can export icons in multiple sizes and formats (SVG, PNG)
### Wallpapers & Visual Assets
- [ ] **WALL-01**: User can generate desktop and mobile wallpapers from a description
- [ ] **WALL-02**: User can generate social media banners with correct dimensions per platform
- [ ] **WALL-03**: User can generate Open Graph and social preview images
- [ ] **WALL-04**: User can generate app icons and favicons in multiple sizes
### Presentations & Video
- [ ] **PRES-01**: User can generate pitch deck presentations from a conversation
- [ ] **PRES-02**: System renders presentations via Remotion to interactive web or MP4
- [ ] **PRES-03**: User can generate demo and explainer videos from conversation content
- [ ] **PRES-04**: System shows render progress via SSE during video generation
### Social Media Content
- [ ] **SOCIAL-01**: User can generate platform-ready posts respecting character limits (Twitter, LinkedIn)
- [ ] **SOCIAL-02**: User can generate Instagram carousels and thread sequences
- [ ] **SOCIAL-03**: System suggests relevant hashtags for generated content
### Branding Media Kit
- [ ] **BRAND-01**: User can generate a full brand identity from a single conversation
- [ ] **BRAND-02**: System produces logo mark (SVG), avatar in multiple sizes
- [ ] **BRAND-03**: System produces social media profile images and banners per platform
- [ ] **BRAND-04**: System produces email signature and letterhead templates
- [ ] **BRAND-05**: System produces a brand guidelines document (PDF)
- [ ] **BRAND-06**: User can download all brand assets as a zip package
### Format Conversion
- [ ] **CONV-01**: User can convert between image formats (PNG, JPG, SVG, WebP, GIF) via sharp
- [ ] **CONV-02**: User can convert between audio/video formats via ffmpeg
- [ ] **CONV-03**: User can convert between document formats (Markdown, HTML, PDF, DOCX) via Pandoc/LibreOffice
- [ ] **CONV-04**: User can convert between data formats (CSV, JSON, XLSX) via direct tooling
- [ ] **CONV-05**: User can convert between any format pair via AI-bridged conversion for semantically complex transforms
- [ ] **CONV-06**: System provides a conversion UI with source/target format selection and drag-drop input
- [ ] **CONV-07**: User can deep-link to specific conversion flows via URL (e.g. `/convert/png/svg`)
- [ ] **CONV-08**: System detects available direct converters at startup and degrades gracefully — unavailable direct paths fall through to AI-bridged conversion rather than showing as blocked
- [ ] **CONV-09**: System validates uploaded file MIME type via magic-byte detection before processing
### Whisper Web Chat
- [ ] **VOICE-01**: User can click a mic button in web chat to record and auto-transcribe via Whisper
- [ ] **VOICE-02**: User can toggle between text-only, voice-input, and full-voice modes
- [ ] **VOICE-03**: Voice input works offline with local Whisper model
### Content as Skills
- [ ] **SKILL-01**: Each content type is implemented as an installable Nexus skill
- [ ] **SKILL-02**: Generalist agent is pre-loaded with a "Creative" skill group
- [ ] **SKILL-03**: Users can add or remove content type skills through the Skill Aggregator
## Future Requirements
Deferred to future release. Tracked but not in current roadmap.
### AI Image Generation
- **AIGEN-01**: User can generate images via local Stable Diffusion / ComfyUI
- **AIGEN-02**: User can generate images via cloud APIs (DALL-E, Midjourney)
### Advanced Voice
- **AVOICE-01**: Wake word detection ("Hey Nexus")
- **AVOICE-02**: Voice call / real-time audio streaming
## Out of Scope
| Feature | Reason |
|---------|--------|
| AI image generation (SD/DALL-E) | VRAM conflicts with LLM on M4; cloud sends data externally |
| Social media publishing | API rate limits, auth complexity; generation only for v1.7 |
| Batch conversion queue | Single-user deployment; one-at-a-time sufficient |
| Real-time collaborative editing of generated content | Single-user target |
| Wake word detection | Future consideration |
| Voice call / real-time audio streaming | Future consideration |
## Traceability
Which phases cover which requirements. Updated during roadmap creation.
| Requirement | Phase | Status |
|-------------|-------|--------|
| — | — | — |
**Coverage:**
- v1.7 requirements: 52 total
- Mapped to phases: 0
- Unmapped: 52
---
*Requirements defined: 2026-04-04*
*Last updated: 2026-04-04 after initial definition*