mattpocock/course-video-manager

document-ai-hero-api

Generate or update documentation for the AI Hero API by reading the source code at ~/repos/ai/course-builder.

Quelltext ansehen

Verwendung

  1. Installationsbefehl kopieren und das Quellpaket vor der Installation in der eigenen Agentenumgebung prüfen.
  2. Benötigte Werkzeuge, Zugangsdaten und Hosts im Original prüfen.
  3. Eingabe und gewünschtes Ergebnis beschreiben und die Ausgabe mit den Quellen abgleichen.
npx skills add https://github.com/mattpocock/course-video-manager --skill document-ai-hero-api

Vor dem Start

  • Die Installation umfasst weder Modellabo noch API-Kontingent oder Dateizugriffsrechte.
  • Sterne und Installationen zeigen Aktivität, keine unabhängige Qualitäts- oder Sicherheitsprüfung.
Originales Skill-Dokument

Aus dem Quell-Repository gerendert; Überschriften, Beispiele, Code, Tabellen, Links und Bilder bleiben erhalten.

Document AI Hero API

Generate/update API documentation by reading the AI Hero source code.

Prerequisites: Ensure Read Permissions

Before reading the AI Hero source, update .claude/settings.local.json to include read permission for the course-builder repo. Add this entry to the permissions.allow array if not already present:

"Read(/home/mattpocock/repos/ai/course-builder/**)"

Workflow

1. Scan API Source

Read the AI Hero API source at ~/repos/ai/course-builder/apps/ai-hero/src/. Focus on:

  • REST endpoints: src/app/api/ — each folder is a route segment. Read every route.ts file.
  • tRPC routers: src/trpc/api/routers/ — each file is a typed RPC router.
  • Database schema: src/db/schema.ts — table definitions and relationships.
  • Auth: src/app/api/auth/ and any middleware files for auth patterns.

2. For Each Endpoint, Capture

  • HTTP method + path (REST) or procedure name + type (tRPC query/mutation)
  • Request body / query params with TypeScript types
  • Response shape with TypeScript types
  • Auth requirements (public, Bearer token, session, HMAC)
  • Side effects (Inngest events, webhooks, S3 uploads)

3. Cross-Reference with This Project

Check how endpoints are consumed in this codebase:

  • app/services/ai-hero-auth-service.ts — OAuth device flow
  • app/services/ai-hero-upload-service.ts — Upload & post creation
  • app/features/upload-manager/ — SSE client for progress

Flag any endpoints used here that have changed in the source.

4. Write Documentation

Output to docs/ai-hero-api.md in this repo. Follow the structure in TEMPLATE.md.

5. Summary

After updating, print a short summary of:

  • Number of endpoints documented
  • Any breaking changes detected vs. current usage
  • Any new endpoints not yet consumed by this project

Verwandte Aufgaben

aus demselben Repository

Weitere Skills

Alle Skills