本文へ移動
cccskills
無料GitHub で公開

document-ai-hero-api

Generate or update documentation for the AI Hero API by reading the source code at ~/repos/ai/course-builder. Use when user wants to document, update docs for, or understand the AI Hero API endpoints.

インストール方法を見る

含まれるファイル(2)

  • SKILL.md2.1 KB
  • TEMPLATE.md1.6 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

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

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Ship a Drizzle schema change end to end — generate the migration, merge, hand Matt the migrate command, redeploy apps/remote, confirm it is green. Use whenever a change adds or edits a file under packages/core/db/migrations/ or changes packages/core/db/schema.ts, or when an apps/remote deploy failed with "production has not applied".

日本語の概要は準備中です。原文の説明を表示しています。

mattpocock/course-video-manager8022026年10月12日 更新

do-work

無料

End-to-end implementation workflow. Use when user wants to implement a feature, fix a bug, or make changes and have everything validated and committed.

日本語の概要は準備中です。原文の説明を表示しています。

mattpocock/course-video-manager8022026年10月12日 更新

Survey the codebase, pick ONE high-leverage deepening opportunity (filtering out anything already proposed), and publish it as a PRD-shaped GitHub issue via /to-prd-project. Designed to run unattended in the daily architecture-review workflow.

日本語の概要は準備中です。原文の説明を表示しています。

mattpocock/course-video-manager8022026年10月12日 更新

Install @effect/* packages safely. Use whenever adding a new Effect ecosystem dependency.

日本語の概要は準備中です。原文の説明を表示しています。

mattpocock/course-video-manager8022026年10月12日 更新

Optimize slow React Router loaders by eliminating redundant DB queries, creating slim query variants, and parallelizing independent fetches. Use proactively when writing or reviewing loader code that calls domain operations services (e.g. CourseOperationsService, VideoOperationsService), or when triaging a slow page load.

日本語の概要は準備中です。原文の説明を表示しています。

mattpocock/course-video-manager8022026年10月12日 更新

Break a PRD into native GitHub sub-issues attached to the parent PRD. Project-local variant of /to-issues, adapted for this repo's PRD-as-parent + native sub-issues + agent:implement multi-session workflow. Argument is the parent PRD issue number.

日本語の概要は準備中です。原文の説明を表示しています。

mattpocock/course-video-manager8022026年10月12日 更新

mattpocock のスキルをすべて見る

このスキルの問題を報告する