Files
youtube-studio-flow/documentation/YouTube Studio Flow/00 - Index.md
T

3.2 KiB

YouTube Studio Flow — Documentation

Multi-tenant YouTube channel management tool. Teams connect channels, manage video metadata via a description block and template system, and push changes back to YouTube.


For Claude — Start Here

Read 00 - Claude Guide before starting any task. It contains a task routing table (which docs to read for which task type) and a list of common mistakes to avoid in this codebase.


Quick Navigation

Architecture

  • 01 - System Overview — Tech stack, process architecture, key decisions
  • 02 - Backend — NestJS modules, patterns, shared services
  • 03 - Frontend — Next.js routing, state management, API layer
  • 04 - Database Schema — Prisma models and relationships
  • 05 - Queue System — BullMQ processors and queue constants
  • 06 - Authentication — Google OAuth, JWT, role-based access
  • 07 - Render Engine — Description rendering pipeline, token resolution

Features

  • 01 - Video Management — Video list, editor, sync
  • 02 - Description Engine — Blocks, templates, tokens, rendering
  • 03 - Metadata Linting — Rules, execution, disabling rules
  • 04 - Bulk Operations — Preview/confirm pattern, rollback
  • 05 - Playlists — YouTube playlist sync
  • 06 - Collaborators — Platform fields, token mapping
  • 07 - Saved Views — Filter presets, pinned tabs
  • 08 - Campaigns — Date-window promotional blocks
  • 09 - Calendar — Scheduled video visualization
  • 10 - Import Export — CSV and JSON workspace transfer
  • 11 - Quota Management — YouTube API quota tracking
  • 12 - Audit Log — Change history
  • 13 - Team Settings — Render settings, lint rule disabling

API Reference

  • 01 - Auth API
  • 02 - Videos API
  • 03 - Blocks API
  • 04 - Templates API
  • 05 - Collaborators API
  • 06 - Linting API
  • 07 - Playlists API
  • 08 - Saved Views API
  • 09 - Teams API
  • 10 - Quota API
  • 11 - Bulk Jobs API
  • 12 - Calendar API
  • 13 - Import Export API
  • 14 - Team Variables API
  • 15 - Campaigns API
  • 16 - YouTube Sync API
  • 17 - Video Configs API

Design Guidelines

  • 01 - Visual Design — Colors, typography, spacing, shadows
  • 02 - CSS Conventions — CSS Modules, variables, min-width rule
  • 03 - Component Patterns — React patterns, TanStack Query, modals
  • 04 - Backend Architecture Patterns — Module structure, scoping, audit
  • 05 - Code Conventions — TypeScript, naming, comments

Development

  • 01 - Local Setup — Prerequisites and step-by-step setup
  • 02 - Environment Variables — All env vars with descriptions
  • 03 - Recipes — How to add modules, rules, endpoints, nav items
  • 04 - Gotchas — Non-obvious behaviors and known traps
  • 05 - Deployment and Operations — Production stack, secrets, job failures, backups, key rotation
  • 06 - Verifying Changes — Build, type-check, and lint commands

Backlog

  • 01 - Technical Debt and Future Work — Dead code, missing features, deferred improvements

Daily Notes

Chronological log of shipped work. Filename format: YYYY-MM-DD NN Short title (NN counts major tasks that day, ascending).