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.

소스 보기

사용 방법

  1. 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
  2. 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
  3. 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
npx skills add https://github.com/mattpocock/course-video-manager --skill document-ai-hero-api

시작 전 확인

  • 설치에는 모델 구독, API 한도, 파일 접근 권한이 포함되지 않습니다.
  • 별점 수와 설치 수는 활동 지표이며 독립적인 품질·보안 검증이 아닙니다.
원본 Skill 문서

원본 저장소의 제목, 예시, 코드, 표, 링크, 이미지를 유지해 표시합니다.

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

관련 작업

같은 저장소의 Skills

더 많은 Skills

모든 Skills