# Factory + VideoKing

Quick links by role:

**New to the team?**
- [Getting Started](./docs/runbooks/getting-started.md) (clone, setup, first deploy)
- [Team Onboarding](./docs/PHASE_A_TEAM_ONBOARDING_PACK.md) (2-hour introduction)

**Frontend Developer?**
- [Frontend Standards](./docs/FACTORY_FRONTEND_STANDARDS.md) (accessibility, performance, testing)
- [Component Library](./apps/admin-studio-ui/docs/COMPONENT_LIBRARY.md) (components + examples)

**Backend/Worker Developer?**
- [Factory Packages](./docs/FACTORY_PACKAGE_MATRIX.md) (which packages, how to use)
- [Database Guide](./docs/runbooks/database.md) (schema, migrations, RLS)

**Operations/DevOps?**
- [Deployment](./docs/runbooks/deployment.md) (staging vs production)
- [SLOs & Monitoring](./docs/videoking/SLO_FRAMEWORK.md) (reliability targets + alerts)

**Product/Design?**
- [Journey Maps](./docs/JOURNEY_MAPS_8_FLOWS.md) (8 critical flows + instrumentation)
- [Design Rubric](./docs/DESIGN_QUALITY_RUBRIC.md) (quality standards + CI gates)

**Want to contribute?**
- [Definition of Ready/Done](./docs/DEFINITION_OF_READY_DONE.md) (quality gates)
- [RFC Process](./docs/RFC_DESIGN_REVIEW_PROCESS.md) (proposal template + approval)

**Full Documentation Index:** [Docs Index](./docs/DOCUMENTATION_INDEX.md)

# Documentation Index

**Last Updated:** [auto-date]  
**Owner:** [Engineering Manager]  
**SLA:** Updated within 3 days of doc creation/move

---

## Section 1: Getting Started

| Document | Purpose | Owner | Last Updated |
|----------|---------|-------|---|
| [Getting Started](./runbooks/getting-started.md) | Clone repo, setup .dev.vars, first local run | Tech Lead | 2026-04-28 |
| [Environment Verification](./ENVIRONMENT_VERIFICATION_SETUP.md) | Pre-flight checks before `npm run dev` | DevOps | 2026-04-01 |

## Section 2: Core Architecture

| Document | Purpose | Owner | Last Updated |
|----------|---------|-------|---|
| [VideoKing Engineering Baseline](./videoking/videoking-engineering-baseline.mdx) | Phase 4 state: schema, DLQ, payouts, tech stack | Core App Lead | 2026-04-28 |
| [Factory Package Matrix](./FACTORY_PACKAGE_MATRIX.md) | Which pkg for what; consumption guide; new app onboarding | Platform Lead | 2026-04-28 |
| [Factory Core Architecture](../factory_core_architecture.md) | Standing orders + package boundaries + hard constraints | Platform Lead | 2026-01-15 |

## Section 3: Quality Standards

| Document | Purpose | Owner | Last Updated |
|----------|---------|-------|---|
| [Design Quality Rubric](./DESIGN_QUALITY_RUBRIC.md) | 6 principles + 15-point component checklist | Design Lead | 2026-04-28 |
| [Frontend Standards](./FACTORY_FRONTEND_STANDARDS.md) | Accessibility (WCAG 2.2), performance (Lighthouse 85), responsive | Design Lead | 2026-04-28 |
| [Definition of Ready/Done](./DEFINITION_OF_READY_DONE.md) | PR gates; DoR checklist; DoD checklist; CI enforcement | Engineering Manager | 2026-04-28 |

## Section 4: Planning & Design

| Document | Purpose | Owner | Last Updated |
|----------|---------|-------|---|
| [Journey Maps (8 Flows)](./JOURNEY_MAPS_8_FLOWS.md) | Viewer, signup, subscribe, unlock, upload, connect, payouts, moderation | Product Lead | 2026-04-28 |
| [RFC & Design Review](./RFC_DESIGN_REVIEW_PROCESS.md) | RFC template; design review workflow; approval gates | Engineering Manager | 2026-04-28 |
| [World-Class Roadmap](../WORLD_CLASS_IMPLEMENTATION_DASHBOARD.md) | 28 initiatives across 7 tracks; phase sequencing | Product Lead | 2026-04-28 |

## Section 5: Operations & Reliability

| Document | Purpose | Owner | Last Updated |
|----------|---------|-------|---|
| [SLO Framework](./videoking/SLO_FRAMEWORK.md) | Tier 1/2/3 targets; error budgets; alert thresholds; weekly cadence | Ops Lead | 2026-04-28 |
| [On-Call Runbook](./videoking/ON_CALL_RUNBOOK.md) | 5-phase incident response; triage; post-mortem | Ops Lead | 2026-04-28 |
| [Deployment](./runbooks/deployment.md) | Staging vs production; smoke tests; rollback | DevOps | 2026-03-15 |
| [Secrets & Tokens](./runbooks/github-secrets-and-tokens.md) | GitHub Secrets inventory; rotation schedule | DevOps | 2026-02-20 |
| [Secret Rotation](./runbooks/secret-rotation.md) | How to rotate JWT, DATABASE_URL, API keys without downtime | DevOps | 2026-02-20 |

## Section 6: Implementation Phases

| Document | Purpose | Owner | Last Updated |
|----------|---------|-------|---|
| [Phase B Launch Check](./IMPLEMENTATION_LAUNCH_CHECKLIST.md) | Pre-kickoff checklist; 5 complete items | Implementation Lead | 2026-04-28 |
| [Phase A Onboarding Pack](./PHASE_A_TEAM_ONBOARDING_PACK.md) | 2-hour quick-start; role-specific resources | Implementation Lead | 2026-04-28 |
| [Phase 6 Checkpoint](../PHASE_6_7_READY_STATE.md) | Infrastructure provisioning status (Neon, Hyperdrive, Sentry) | Platform Lead | 2026-01-20 |

---

## Update Schedule

| Document Tier | Review Cadence | Owner |
|---|---|---|
| Getting Started | Weekly (on-demand if issues) | Tech Lead |
| Architecture | Monthly (after major changes) | Tech Lead |
| Process/Standards | Monthly (after policy changes) | Engineering Manager |

---

docs/
├── README.md (Tier 1: landing page)
├── DOCUMENTATION_INDEX.md (Tier 2: comprehensive listing)
│
├── runbooks/
│   ├── getting-started.md
│   ├── deployment.md
│   ├── database.md
│   ├── github-secrets-and-tokens.md
│   ├── secret-rotation.md
│   ├── lessons-learned.md
│   └── environment-isolation-and-verification.md
│
├── videoking/
│   ├── videoking-engineering-baseline.mdx
│   ├── SLO_FRAMEWORK.md
│   ├── ON_CALL_RUNBOOK.md
│   ├── IMPLEMENTATION_KICKOFF_APRIL_28.md
│   └── ...
│
├── packages/
│   ├── auth.mdx
│   ├── neon.mdx
│   ├── stripe.mdx
│   └── ...
│
└── QUALITY_STANDARDS/
    ├── DESIGN_QUALITY_RUBRIC.md
    ├── FACTORY_FRONTEND_STANDARDS.md
    ├── DEFINITION_OF_READY_DONE.md
    └── ...

# Admin Studio UI

Frontend for creator dashboard (earnings, videos, subscribers).

## Quick Start

# Clone + dependencies
npm install

# Local dev (connects to staging API)
npm run dev    # http://localhost:3000

# Build for production
npm run build

## Key Directories

- `src/pages/` — Page components (route-based)
- `src/components/` — Reusable UI components
- `src/hooks/` — Custom React hooks
- `src/styles/` — Tailwind CSS + custom styles
- `tests/` — Vitest tests

## Common Tasks

**Add a new page:**
1. Create `src/pages/YourPage.tsx`
2. Add route in routing config
3. Add tests in `tests/pages/YourPage.test.tsx`

**Use a component:**
```typescript
import { Button } from '@/components/Button';
<Button variant="primary">Submit</Button>

---

## Part 2: Documentation Standards

### Metadata Header (Every Doc)

Every doc 2+ pages should start with:

```markdown
---
title: Document Title
description: One-sentence summary
last_updated: 2026-04-28
owner: [Name + Slack handle]
sla: [How often updated? e.g., "Weekly" or "On-demand"]
---

# Document Title

**Status:** ✅ Current (/ ⚠️ Needs Review / ❌ Stale)
**Last Updated:** April 28, 2026 by [Name]
**SLA:** Updated within [X days] of [event]

---

---
title: SLO Framework
description: Service-level objectives, error budgets, alert rules for VideoKing
last_updated: 2026-04-28
owner: Ops Lead (ops-lead@slack)
sla: Updated quarterly or within 1 week of SLO miss
---

# Service-Level Objectives Framework

**Status:** ✅ Current  
**Last Updated:** April 28, 2026 by Ops Lead  
**SLA:** Updated quarterly (next review: July 28) or within 1 week if SLO missed

---

// Deploy SLO metrics to PostHog
try {
  const metrics = await collectSLOMetrics(env);
  
  // Track each metric as a PostHog event
  // (PostHog auto-batches events; no retry needed)
  await posthog.capture({
    event: 'slo_metrics_collected',
    properties: metrics,
  });
} catch (err) {
  // If PostHog fails, don't break the rest of the job
  // Log error for debugging; continue
  logger.error('posthog_collection_failed', { error: err.message });
}

---
title: Phase 6 Setup (DEPRECATED)
status: ❌ Stale (replaced by automated orchestrator)
---

# ⚠️ DEPRECATED: Phase 6 Setup

**This guide was for manual Phase 6 provisioning. As of April 28, 2026, use:**
- `npm run phase-6:provision` (automated orchestrator)
- See: [Phase 6 Orchestrator](../scripts/phase-6-orchestrator.mjs)

---

## Original Content (for reference)

[... original doc content ...]