FRD Index
A directory of all Functional Requirements Documents and design documents across the SMACKZ platform. These files live in the docs/ repo and individual service repos, not in this wiki.
Lakehouse FRDs
| Document |
Repo Path |
Phase |
Status |
Summary |
| Lakehouse Metabase UI FRD |
docs/Smackz-Phase2/Lakehouse-Metabase-UI-FRD.md |
3-5 |
Done |
Self-service analytics UI with DuckDB + Metabase, 5 dashboards, ML export |
| Data Catalog FRD |
smackz-lakehouse/docs/Lakehouse-Data-Catalog-FRD.md |
6 |
Done |
Metadata layer for table/column/relationship documentation |
| Metrics Layer FRD |
smackz-lakehouse/docs/Lakehouse-Metrics-Layer-FRD.md |
7 |
Done |
Canonical metric definitions as DuckDB views |
| Data Quality FRD |
smackz-lakehouse/docs/Lakehouse-Data-Quality-FRD.md |
8 |
Done |
Automated quality checks with catalog-driven rules |
| Lakehouse Roadmap |
smackz-lakehouse/docs/LAKEHOUSE-ROADMAP.md |
-- |
Active |
Full phase roadmap with timeline |
| Document |
Repo Path |
Status |
Summary |
| Loyalty Lifecycle Workers FRD |
docs/Smackz-Phase2/Loyalty-Lifecycle-Workers-FRD.md |
Ready |
Points expiry, tier advancement, offer expiry background workers |
| Agentic Workflows Reclassification |
docs/Smackz-Phase2/Agentic-Workflows-Reclassification-Proposal.md |
Draft |
Reclassification of agentic vs. deterministic workflows (10 agents, 26 workers, 6 hybrid) |
| Security Scanning FRD |
docs/Smackz-Phase2/Security-Scanning-FRD.md |
Draft |
Automated security scanning pipeline (SCA, container CVE, SAST, org baseline) |
| Platform NFR Governance |
docs/Smackz-Phase2/Platform-NFR-Governance.md |
Draft |
27 NFRs across functionality integrity, security, vulnerability scanning |
Integration FRDs
| Document |
Repo Path |
Status |
Summary |
| POS Integrations FRD |
docs/POS-Integrations-FRD.md |
Active |
Clover POS integration design and multi-tenant connection flow |
| Smackz MCP FRD |
docs/Smackz-MCP-FRD.md |
Active |
Model Context Protocol server for LLM integration |
Feature FRDs
| Document |
Repo Path |
Status |
Summary |
| Multi-Location Restaurant Support |
docs/Multi-Location-Restaurant-Support-FRD.md |
Draft |
Multi-location support for restaurant chains |
| Website Builder FRD |
docs/Website-Builder-FRD.md |
Draft |
Visual website builder for restaurant owners |
| Edge Caching FRD |
docs/Edge-Caching-FRD.md |
Draft |
CDN edge caching strategy |
| Font Registry FRD |
docs/Font-Registry-FRD.md |
Draft |
Typography font registry and management |
| Feature Flags Requirements |
docs/Feature-Flags-Requirements.md |
Draft |
Feature flag system requirements |
| E2E Tracing FRD |
docs/E2E-Tracing-FRD.md |
Draft |
End-to-end request tracing |
| Test Runner FRD |
docs/Test-Runner-FRD.md |
Draft |
Automated test execution framework |
| Visual Tracing FRD |
docs/Visual-Tracing-FRD.md |
Draft |
Visual tracing and debugging |
| Theme System V2 FRD |
docs/Theme-System-V2-FRD.md |
Draft |
Multi-tier brand palettes, surface roles, contextual fonts, expanded button variants |
Architecture Reviews
| Document |
Repo Path |
Status |
Summary |
| Async Migration Review |
docs/ARCHITECTURE_ASYNC_MIGRATION.md |
Analysis |
Async-first inter-service communication migration plan (triggered by 504 incident) |
| Agentic Framework Evaluation |
docs/Smackz-Agentic-Framework-Evaluation.md |
Draft |
CrewAI vs DeepAgents comparison; recommends DeepAgents (LangGraph) primary, CrewAI for content crews |
Visual Editor Specs
| Document |
Repo Path |
Status |
Summary |
| Selection Overlay Design |
docs/superpowers/specs/2026-04-16-viseditor-01-selection-overlay-design.md |
Design |
Click-to-select overlay with hit-test engine for section preview |
| Floating Toolbar Design |
docs/superpowers/specs/2026-04-16-viseditor-02-floating-toolbar-design.md |
Design |
Contextual floating toolbar with role-based editing controls |
| Drag Text Container Design |
docs/superpowers/specs/2026-04-16-viseditor-03-drag-text-container-design.md |
Design |
Drag-to-position text container on hero sections |
| Phone Preview Parity Design |
docs/superpowers/specs/2026-04-18-phone-preview-rn-parity-design.md |
Design |
Phone viewport preview matching RN mobile renderer |
Design Documents
| Document |
Repo Path |
Summary |
| Auth System |
docs/Auth-System.md |
Cross-project authentication overview |
| CI/CD Workflows |
docs/CI-CD-Workflows.md |
Shared package publishing and consumption |
| Menu System |
docs/Menu-System.md |
Menu data model and operations |
| Dynamic Pages |
docs/DynamicPages.md |
Dynamic page and section architecture |
| Theme Architecture |
docs/Theme-Architecture.md |
Restaurant theming system |
| Notifications |
docs/Notifications.md |
Notification system design |
| Food Truck Location Support |
docs/Food-Truck-Location-Support.md |
Mobile location support for food trucks |
| Yum SDK Design |
docs/Yum-SDK-Design.md |
SDK for Yum API consumption |
| Theme System V2 Design |
docs/Theme-System-V2-Design.md |
Technical design — schema, generator, renderer changes for V2 |
| Theme System V2 Gap Analysis |
docs/Theme-System-V2-Gap-Analysis.md |
Pillar-by-pillar comparison vs Starbucks design.md spec |
Analysis Documents
| Document |
Repo Path |
Summary |
| Feature Flags Solution Analysis |
docs/Feature-Flags-Solution-Analysis.md |
Comparison of feature flag solutions |
| E2E Testing Framework Evaluation |
docs/E2E-Testing-Framework-Evaluation.md |
Test framework comparison |
| AI-Assisted Test Generation |
docs/AI-Assisted-Test-Generation-Evaluation.md |
Evaluation of AI test generation tools |
| E2E Testing Decision |
docs/infra/E2E-Testing-Decision-Document.md |
Final testing framework decision |
Where to Find FRDs
- Cross-project FRDs:
docs/ (root-level docs repo)
- Phase 2 FRDs:
docs/Smackz-Phase2/
- Lakehouse FRDs:
smackz-lakehouse/docs/
- Repo-specific docs:
<repo>/docs/ (e.g., yum/docs/, Smackz-Websites/docs/)
Always check docs/ first before searching individual repos -- it serves as the index for all project documentation.