diff --git a/apps/web/src/app/docs/api/page.tsx b/apps/web/src/app/docs/api/page.tsx index e358ccafb..b6eb248b1 100644 --- a/apps/web/src/app/docs/api/page.tsx +++ b/apps/web/src/app/docs/api/page.tsx @@ -2,6 +2,7 @@ import type { Metadata } from 'next'; import Link from 'next/link'; import Nav from '@/components/Nav'; import Footer from '@/components/Footer'; +import DownloadMarkdownButton from '@/components/docs/DownloadMarkdownButton'; export const metadata: Metadata = { title: 'API Reference', @@ -48,12 +49,62 @@ const LINK_CLASS = 'text-[var(--uvai-accent-ink,var(--uvai-accent))] underline-offset-4 hover:underline'; const CODE_CLASS = 'text-[var(--uvai-accent-ink,var(--uvai-accent))]'; +const LAUNCH_CHECKLIST = [ + { + phase: '1. Workspace & source intake', + items: [ + 'Normalize YouTube URL identity (`video_id` + `source_hash`) before queuing extraction.', + 'Persist `language`, theme mode (`data-theme`), and WCAG AAA contrast (`data-contrast`).', + ], + }, + { + phase: '2. Design system & breakpoints', + items: [ + 'Keep Webflow/MDN persistent left sidebar active down to 600px half-screen widths.', + 'Enforce zero horizontal overflow (`scrollWidth <= innerWidth`) across 720x900 and 1440x900.', + ], + }, + { + phase: '3. Video Pack & G.A.T.E. spec', + items: [ + 'Render numbered syllabus chapters, clickable transcript timestamps, and detected stack tools.', + 'Keep Deliverables consolidated into 4 plain-English tabs: Preview, Tasks & Tools, Code & Spec, Transcript.', + ], + }, + { + phase: '4. WebMCP & tool harnesses', + items: [ + 'Expose declarative `
` and `document.modelContext` tools within Chrome limits.', + 'Export downloadable Markdown specs (`.md`) ready for Claude, Cursor, or ChatGPT.', + ], + }, + { + phase: '5. Pre-launch Security, LCP & Accessibility QA', + items: [ + 'Prioritize video poster image loading (`fetchPriority="high"`) and automatic embed fallback.', + 'Audit heading hierarchy, form field labels/ids, keyboard focus rings, and CodeQL sanitization.', + ], + }, +] as const; + +const DOCS_MARKDOWN = `# UVAI Operational Reference & Build Checklist + +Base URL: https://uvai.io +Workflow: YouTube URL -> POST /api/video/pack -> POST /api/workflows/video-to-actions -> /d/[videoId] + +## Endpoints +${ENDPOINTS.map((e) => `- \`${e.method} ${e.path}\` — ${e.summary}`).join('\n')} + +## Build & Launch Checklist +${LAUNCH_CHECKLIST.map((s) => `### ${s.phase}\n${s.items.map((i) => `- [ ] ${i}`).join('\n')}`).join('\n\n')} +`; + export default function ApiDocsPage() { return (
-
+ + +
+
+
+

UVAI Operational Documentation

+

API Reference

+

+ UVAI exposes a small, REST-style surface for transcription, event + extraction, and search. All endpoints accept and return JSON unless noted. +

+

+ The legacy /api/pipeline and{' '} + /api/pipeline/stream routes are retired.{' '} + GET /api/video is a health probe.{' '} + POST /api/video remains for compatibility but is deprecated; + use POST /api/video/pack. +

+
+ +
+

Base URL

+ https://uvai.io +

+ Want to run it yourself? UVAI is MIT-licensed.{' '} + - {e.method} + See the EventRelay repo + {' '} + for self-hosting. +

+
+ +
+

Endpoints

+
    + {ENDPOINTS.map((e) => ( +
  • + + {e.method} + +
    + {e.path} +

    {e.summary}

    + {e.body ? ( +
    +                          {e.body}
    +                        
    + ) : null} +
    +
  • + ))} +
+
+ +
+
+

+ Build & Launch Checklist +

+ + Webflow · MDN QA alignment -
- {e.path} -

{e.summary}

- {e.body ? ( -
-                      {e.body}
-                    
- ) : null} -
- - ))} - -
- -
-

Try it

-

- The{' '} - - studio - {' '} - runs the end-to-end YouTube workflow against a real URL: hashed Video - Pack via /api/video/pack, then{' '} - /api/workflows/video-to-actions. -

-
    -
  1. Paste a YouTube URL on Home.
  2. -
  3. Home redirects to /studio?video=....
  4. -
  5. Studio auto-starts analysis once for that handoff URL.
  6. -
  7. Transcript and events flow into actions and output publishing.
  8. -
-
+
+
+ {LAUNCH_CHECKLIST.map((group) => ( +
+

{group.phase}

+
    + {group.items.map((item) => ( +
  • {item}
  • + ))} +
+
+ ))} +
+ + +
+

Try it

+

+ The{' '} + + studio + {' '} + runs the end-to-end YouTube workflow against a real URL: hashed Video + Pack via /api/video/pack, then{' '} + /api/workflows/video-to-actions. +

+
    +
  1. Paste a YouTube URL on Home.
  2. +
  3. Home redirects to /studio?video=....
  4. +
  5. Studio auto-starts analysis once for that handoff URL.
  6. +
  7. Transcript and events flow into actions and output publishing.
  8. +
+
+
+ + +