From e6189ff765672535c0709b0cb23a4267ec406515 Mon Sep 17 00:00:00 2001 From: Kun Chen Date: Sun, 16 Aug 2026 20:13:12 -0700 Subject: [PATCH 1/2] chore(agents): use @AGENTS.md import instead of CLAUDE.md symlink --- AGENTS.md | 7 ++++ CLAUDE.md | 3 +- marketing-video/AGENTS.md | 43 +++++++++++++++++++- marketing-video/CLAUDE.md | 84 +-------------------------------------- 4 files changed, 53 insertions(+), 84 deletions(-) mode change 120000 => 100644 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md index b2f327e..118759a 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -60,3 +60,10 @@ Release PRs update `package.json` and `extension/manifest.json`. When a release is created, GitHub Actions builds the extension, packages `extension/` as `simplewords.zip`, and attaches the zip to the GitHub Release. Chrome Web Store publishing runs through `scripts/chrome-web-store-publish.mjs` only when the `SUBMIT_KEYS` GitHub secret is configured. + +## Maintaining this file + +Keep this file for knowledge useful to almost every future agent session in this project. +Do not repeat what the codebase already shows; point to the authoritative file or command instead. +Prefer rewriting or pruning existing entries over appending new ones. +When updating this file, preserve this bar for all agents and keep entries concise. diff --git a/CLAUDE.md b/CLAUDE.md deleted file mode 120000 index 47dc3e3..0000000 --- a/CLAUDE.md +++ /dev/null @@ -1 +0,0 @@ -AGENTS.md \ No newline at end of file diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..a9d4d26 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,2 @@ + +@AGENTS.md diff --git a/marketing-video/AGENTS.md b/marketing-video/AGENTS.md index ef9e568..7c244e4 100644 --- a/marketing-video/AGENTS.md +++ b/marketing-video/AGENTS.md @@ -10,6 +10,26 @@ npx skills add heygen-com/hyperframes Skills encode patterns like `window.__timelines` registration, `data-*` attribute semantics, Tailwind v4 browser-runtime styling for `--tailwind` projects, and shader-compatible CSS rules that are not in generic web docs. Using them produces correct compositions from the start. +**Always invoke the relevant skill before writing or modifying compositions.** Skipping them produces broken compositions. + +| Skill | Command | When to use | +| -------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------- | +| **hyperframes** | `/hyperframes` | Creating or editing HTML compositions, captions, TTS, audio-reactive animation, marker highlights | +| **hyperframes-cli** | `/hyperframes-cli` | Dev-loop CLI: init, lint, inspect, preview, render, doctor | +| **hyperframes-media** | `/hyperframes-media` | Asset preprocessing: tts (Kokoro), transcribe (Whisper), remove-background (u2net) | +| **hyperframes-registry** | `/hyperframes-registry` | Installing blocks and components via `hyperframes add` | +| **website-to-hyperframes** | `/website-to-hyperframes` | Capturing a URL and turning it into a video — full website-to-video pipeline | +| **tailwind** | `/tailwind` | Tailwind v4 browser-runtime styles for projects created with `hyperframes init --tailwind` | +| **gsap** | `/gsap` | GSAP animations for HyperFrames — tweens, timelines, easing, performance | +| **animejs** | `/animejs` | Anime.js animations registered on `window.__hfAnime` | +| **css-animations** | `/css-animations` | CSS keyframes that HyperFrames can pause and seek | +| **lottie** | `/lottie` | `lottie-web` and dotLottie players registered on `window.__hfLottie` | +| **three** | `/three` | Three.js scenes rendered from HyperFrames `hf-seek` events | +| **waapi** | `/waapi` | Web Animations API motion driven through `document.getAnimations()` | + +> **Skills not available?** Ask the user to run `npx hyperframes skills` and restart their +> agent session, or install manually: `npx skills add heygen-com/hyperframes`. + ## Commands ```bash @@ -17,6 +37,8 @@ pnpm run dev # preview in browser (studio editor) pnpm run check # lint + validate + inspect pnpm run render # render to MP4 pnpm run publish # publish and get a shareable link +npx hyperframes lint --verbose # include info-level findings +npx hyperframes lint --json # machine-readable output for CI npx hyperframes docs # reference docs in terminal ``` @@ -53,6 +75,25 @@ Fix all errors before presenting the result. ## Documentation +**For quick reference**, use the local CLI docs command (no network required): + +```bash +npx hyperframes docs +``` + +Topics: `data-attributes`, `gsap`, `compositions`, `rendering`, `examples`, `troubleshooting` + Full docs: https://hyperframes.heygen.com/introduction -Machine-readable index for AI tools: https://hyperframes.heygen.com/llms.txt +**For full documentation**, discover pages via the machine-readable index — do NOT guess URLs: + +``` +https://hyperframes.heygen.com/llms.txt +``` + +## Maintaining this file + +Keep this file for knowledge useful to almost every future agent session in this project. +Do not repeat what the codebase already shows; point to the authoritative file or command instead. +Prefer rewriting or pruning existing entries over appending new ones. +When updating this file, preserve this bar for all agents and keep entries concise. diff --git a/marketing-video/CLAUDE.md b/marketing-video/CLAUDE.md index 2f47d3f..a9d4d26 100644 --- a/marketing-video/CLAUDE.md +++ b/marketing-video/CLAUDE.md @@ -1,82 +1,2 @@ -# HyperFrames Composition Project - -## Skills — USE THESE FIRST - -**Always invoke the relevant skill before writing or modifying compositions.** Skills encode framework-specific patterns (e.g., `window.__timelines` registration, `data-*` attribute semantics, shader-compatible CSS rules) that are NOT in generic web docs. Skipping them produces broken compositions. - -| Skill | Command | When to use | -| -------------------------- | ------------------------- | ------------------------------------------------------------------------------------------------- | -| **hyperframes** | `/hyperframes` | Creating or editing HTML compositions, captions, TTS, audio-reactive animation, marker highlights | -| **hyperframes-cli** | `/hyperframes-cli` | Dev-loop CLI: init, lint, inspect, preview, render, doctor | -| **hyperframes-media** | `/hyperframes-media` | Asset preprocessing: tts (Kokoro), transcribe (Whisper), remove-background (u2net) | -| **hyperframes-registry** | `/hyperframes-registry` | Installing blocks and components via `hyperframes add` | -| **website-to-hyperframes** | `/website-to-hyperframes` | Capturing a URL and turning it into a video — full website-to-video pipeline | -| **tailwind** | `/tailwind` | Tailwind v4 browser-runtime styles for projects created with `hyperframes init --tailwind` | -| **gsap** | `/gsap` | GSAP animations for HyperFrames — tweens, timelines, easing, performance | -| **animejs** | `/animejs` | Anime.js animations registered on `window.__hfAnime` | -| **css-animations** | `/css-animations` | CSS keyframes that HyperFrames can pause and seek | -| **lottie** | `/lottie` | `lottie-web` and dotLottie players registered on `window.__hfLottie` | -| **three** | `/three` | Three.js scenes rendered from HyperFrames `hf-seek` events | -| **waapi** | `/waapi` | Web Animations API motion driven through `document.getAnimations()` | - -> **Skills not available?** Ask the user to run `npx hyperframes skills` and restart their -> agent session, or install manually: `npx skills add heygen-com/hyperframes`. - -## Commands - -```bash -pnpm run dev # preview in browser (studio editor) -pnpm run check # lint + validate + inspect -pnpm run render # render to MP4 -pnpm run publish # publish and get a shareable link -npx hyperframes lint --verbose # include info-level findings -npx hyperframes lint --json # machine-readable output for CI -npx hyperframes docs # reference docs in terminal -``` - -## Documentation - -**For quick reference**, use the local CLI docs command (no network required): - -```bash -npx hyperframes docs -``` - -Topics: `data-attributes`, `gsap`, `compositions`, `rendering`, `examples`, `troubleshooting` - -**For full documentation**, discover pages via the machine-readable index — do NOT guess URLs: - -``` -https://hyperframes.heygen.com/llms.txt -``` - -## Project Structure - -- `index.html` — main composition (root timeline) -- `assets/` - source media files used by the marketing video -- `simplewords-marketing.mp4` - rendered marketing video output from `pnpm run render` -- `meta.json` — project metadata (id, name) -- `transcript.json` — whisper word-level transcript (if generated) - -## Linting — ALWAYS RUN AFTER CHANGES - -After creating or editing any `.html` composition, **always** run the full check before considering the task complete: - -```bash -pnpm run check -``` - -Fix all errors before presenting the result. Inspect warnings should be reviewed before rendering. - -## Key Rules - -1. Every timed element needs `data-start`, `data-duration`, and `data-track-index` -2. Elements with timing **MUST** have `class="clip"` — the framework uses this for visibility control -3. Timelines must be paused and registered on `window.__timelines`: - ```js - window.__timelines = window.__timelines || {} - window.__timelines['composition-id'] = gsap.timeline({ paused: true }) - ``` -4. Videos use `muted` with a separate `