Browse documentation

Frontend Specs

RankFlow AI — Frontend Specification Index

Document Version: 1.0.0

docs/specs/frontend/frontend-spec-index.md
On this page

Document Version: 1.0.0 Date: 2026-06-15 Scope: Complete index of all frontend specification documents


Document Overview#

This index serves as the master reference for all frontend specification documents in the RankFlow AI project. Each document follows the 10-point specification template for every widget:

  1. Purpose
  2. Visual Layout
  3. Data Source (tRPC endpoint)
  4. Zod Schema
  5. Fetch Frequency
  6. Data Manipulations
  7. Rationale
  8. Interaction Flows
  9. Error States
  10. Role-Based Variations

Design system constraints (non-negotiable across all docs):

  • NO bold font weight. font-weight: 500 (Medium) maximum.
  • Ember Orange #EC652B is ONLY for primary CTAs, focus rings, positive indicators.
  • Page max-width: 1200px centered. Canvas background: Paper White #F6F6F8.
  • Sidebar: 240px wide. Client uses deep-ink (#011821). Admin uses carbon (#12161E).
  • Section gap: 80px. Card radius: 8px.
  • Medical compliance: 24h approval queue for CLINIC/HOSPITAL/DOCTOR clients.

Design System & Foundation#

File Lines Size Description
frontend-spec-01-design-system.md ~1,200 38KB Brand tokens, color palette, typography, spacing, component patterns, animation principles

Client Dashboard (Non-Admin Screens)#

File Lines Size Description
part-1.md ~847 40KB Pre-Sales, Auth, Onboarding
part-2.md ~2,650 117KB Dashboard KPI, GBP, Social, Citations, Site Management
part-3.md ~1,139 59KB Content, Leads, Reports, Settings + Admin partial intro

Part 1 — Pre-Sales & Onboarding#

  • Section 1: Pre-Sales Landing Pages (homepage, pricing, features)
  • Section 2: Auth Screens (login, signup, password reset, 2FA)
  • Section 3: Onboarding Flow (welcome, business profile, category selection, plan selection, payment, completion)

Part 2 — Core Dashboard Modules#

  • Section 4: Design System Quick Reference (inline recap)
  • Section 5: Dashboard Home (/dashboard) — KPI Overview, Activity Feed, Quick Actions
  • Section 6: GBP Management (/dashboard/gbp) — Dashboard, Post Manager, Review Inbox, Insights, Q&A
  • Section 7: Social Media (/dashboard/social) — Dashboard, Account Manager, Composer, Calendar
  • Section 8: Citations (/dashboard/citations) — Dashboard, Directory Grid, NAP Health, Submission Tracker
  • Section 9: Site Management (/dashboard/site) — Dashboard, Section Editor, Template Gallery, Publish Control

Part 3 — Content, Leads & Settings#

  • Section 9 (cont.): Content Management (/dashboard/content) — Dashboard, List, Editor, Calendar, Approval Queue
  • Section 10: Leads (/dashboard/leads) — Dashboard, List, Detail, Form Modal
  • Section 11: Reports (/dashboard/reports) — Report Builder, Scheduled Reports, Library
  • Section 12: Settings (/dashboard/settings) — Profile, Business, Billing, Notifications, Security, Connected Accounts
  • Section 13: Admin Dashboard Intro (partial, completed in admin specs below)

Admin Dashboard (ADMIN-only Screens)#

File Lines Size Sections Description
admin-spec-01-full.md 1,131 61KB 1–3 KPI Overview, Client Management, Workflow Monitor
admin-spec-02-ai-blog-prompts.md 955 56KB 4–6 AI Evaluation, Blog Manager, Prompt Manager
admin-spec-03a-system.md 384 22KB 7 System Configuration
admin-spec-03b-alerts.md 471 26KB 8 Alert Manager
admin-spec-03c-audit.md 370 23KB 9 Audit & Logs
admin-spec-03d-data-governance.md 536 31KB 10 Data Governance
admin-spec-04a-performance.md 535 33KB 11 Performance Monitor
admin-spec-04b-admin-billing.md 619 37KB 12 Admin Billing
admin-spec-04c-admin-reports.md 539 32KB 13 Admin Reports
admin-spec-04d-security.md 552 38KB 14 Security
admin-spec-04e-landing-pages.md 623 44KB 15 Admin Landing Pages

Admin Section Breakdown#

Section Route Screen Name File
1 /admin/kpi Admin KPI Overview admin-spec-01-full.md
2 /admin/clients Client Management admin-spec-01-full.md
3 /admin/workflows Workflow Monitor admin-spec-01-full.md
4 /admin/ai-evaluation AI Evaluation admin-spec-02-ai-blog-prompts.md
5 /admin/blog Blog Manager admin-spec-02-ai-blog-prompts.md
6 /admin/prompts Prompt Manager admin-spec-02-ai-blog-prompts.md
7 /admin/system System Configuration admin-spec-03a-system.md
8 /admin/alerts Alert Manager admin-spec-03b-alerts.md
9 /admin/audit Audit & Logs admin-spec-03c-audit.md
10 /admin/data-governance Data Governance admin-spec-03d-data-governance.md
11 /admin/performance Performance Monitor admin-spec-04a-performance.md
12 /admin/billing Admin Billing admin-spec-04b-admin-billing.md
13 /admin/reports Admin Reports admin-spec-04c-admin-reports.md
14 /admin/security Security admin-spec-04d-security.md
15 /admin/landing-pages Admin Landing Pages admin-spec-04e-landing-pages.md

Total Specification Coverage#

Category Files Total Lines Total Size Widgets
Design System 1 ~1,200 38KB Tokens, patterns, principles
Client Dashboard 3 ~4,636 216KB ~45 widgets across 12 modules
Admin Dashboard 11 ~6,715 421KB ~45 widgets across 15 sections
Total 15 ~12,551 ~675KB ~90 widgets

Key Cross-Cutting Patterns#

Fetch Frequencies Used#

Frequency Interval Used For
Real-time 10s Jobs, alerts, system metrics, active sessions, security events
Frequent 30s Content status, export status, deletion requests, log feeds, API latency, A/B tests
Standard 1min Subscriptions, invoices, scheduled reports, workflow status
Slow 5min System config, integration status, retention data, security score, revenue, table health
Static On-demand Report builder, SEO analysis, EXPLAIN plans, previews

Role Access Matrix#

Role Client Dashboard Admin Dashboard Impersonation
ADMIN ✅ Full ✅ Full Read-only
CLIENT ✅ Full ❌ 403 N/A
EDITOR ✅ Limited (content only) ❌ 403 N/A
VIEWER ✅ Read-only ❌ 403 N/A

Zod Schema Patterns#

  • All tRPC inputs validated with Zod
  • All API responses typed with Zod schemas
  • All forms use Zod for client-side validation
  • All enums use z.enum() for type safety
  • All dates use z.date() with consistent formatting
  • All monetary values in cents (integer) to avoid floating-point errors

Last updated: 2026-06-16. All 15 sections of the admin specification are now complete. No sections are missing.