Skip to content

docs: Prompt Guide as a novice-to-capstone arc + text corrections from validation#2109

Open
vanceingalls wants to merge 40 commits into
mainfrom
fix/prompt-guide-validation-bugs
Open

docs: Prompt Guide as a novice-to-capstone arc + text corrections from validation#2109
vanceingalls wants to merge 40 commits into
mainfrom
fix/prompt-guide-validation-bugs

Conversation

@vanceingalls

@vanceingalls vanceingalls commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

Two bodies of documentation work from the prompt-guide campaign:

1. Prompt Guide restructured as a novice-to-capstone arc

The 29-page reference manual (by-video-type / by-feature sections) is now a single novice-to-advanced
arc — no standalone reference sections survive ("full dissolve"). Every page becomes a chapter at the
level where the reader is ready for it, with an entry bridge ("you can already X — this adds Y") and
a literal exit bridge (*Next: [Title](/slug) — clause.*) chaining straight into the next chapter.
Bridge-chain integrity was verified end to end: all 30 chapters' exit bridges point at the actual next
page in nav order, zero mismatches.

  • Level 1 — Your first video: workflow rides (product-launch, explainers, code & PRs, captions &
    talking-heads, music & slideshows, motion graphics), reframed as one-prompt first wins; gains a new
    Changelog videos section for the /changelog-video skill, validated with a real build against
    this repo's own last-two-weeks digest.
  • Level 2 — Control: anatomy, specification dial, vocabulary, visual specs; examples becomes the
    level-end gallery. Anatomy gains a note on the composition-structure mandate (feat(skills): add COMPOSITION_STRUCTURE to feedback repro packet + soft-warn lint #2599).
  • Level 3 — Life: motion grammar, transitions.
  • Level 4 — Substance: code blocks, data & maps, overlays, captions catalog, generated artwork,
    VFX, runtimes & 3D — reframed as additive capabilities layered onto earlier chapters.
  • Level 5 — Voice and sound: media & audio, plus a new Bring any footage section documenting
    the automatic HEVC/hostile-codec proxy subsystem (refactor(parsers): single shared FFmpeg/FFprobe binary resolver #2585feat(media): alpha-capable authoring proxies #2598), validated with a real HEVC test
    clip built into a picture-in-picture piece.
  • Level 6 — Scale: design systems, variables & templating (with a correction for the
    variables-no-longer-shadow-authored-CSS fix, fix(core): stop composition variables from shadowing authored CSS custom properties #2553), a brand-new Storyboards chapter (prompting
    the plan instead of the scenes — arc, direction block, one breather, one callback, per-frame
    negative list — validated with a real silent 3-frame build), editing, iterating, recreating
    references, rendering & output, Remotion migration.
  • Level 7 — Capstone: a new chapter built around a real public promo film for HyperFrames itself
    ("Write HTML. Render video.") — 7 frames, ~48s, one long-form prompt that composes nearly every
    technique the guide teaches (kinetic type, per-character code typing, a matched-motion transition,
    real data-viz, a generated-artwork hybrid, a continuous camera-push montage, and a callback +
    breather landing). The prompt is printed in full and dissected chapter-by-chapter. Exposes ground/
    ink/productName as composition variables and ships both the default render and a --variables
    re-skin — including an honest note that one frame (a generated illustration) bakes its palette at
    generation time and doesn't follow the CSS-driven override the other six frames do.
  • Appendix: rules-and-anti-patterns becomes the consolidated cheat sheet (existing rules link
    back to where they're taught) plus 8 new lint-rule rows — seek-order safety, cold-seek visibility,
    SVG draw-on — each grounded against the actual linter source (packages/lint/src/rules/gsap.ts),
    phrased as prompt guidance.

New validation builds beyond the existing 64 embedded renders: changelog-video, proxy-footage,
storyboard-mini, and the capstone film (default + re-skin) — each built exactly as written by a
fresh builder agent, passing lint/check, rendered, and frame-verified before its page shipped.

2. Text corrections from the validation campaign

  • hyperframes-core SKILL.md — "First-pass lint gotchas": root element needs data-start="0"; initial states via gsap.fromTo, never CSS transform + tween on the same property.
  • docs/concepts/compositions.mdxdata-composition-src resolves relative to the project root, not the referencing file.
  • gsap-transforms-and-perf.mdcreateElementNS SVG has no reliable center pivot; draw at local (0,0) inside a positioning <g>.

Behavior fixes from the same campaign are in #2110; Tier 3 block bugs tracked in #2107.

Test plan

  • All new validation builds (changelog-video, proxy-footage, storyboard-mini, capstone
    default + re-skin) pass lint/check/render exactly as written by a fresh builder agent
  • Every embedded S3 URL across the guide (68 total) verified serving (200, video/mp4)
  • docs.json parses; full nav walked and every exit bridge verified against the actual next
    chapter in order (0 mismatches across all 30 chapters)
  • bun run format:check and mintlify broken-links both clean
  • Capstone film's technique-table coverage independently verified frame-by-frame (ffprobe +
    visual frame extraction) against the render, not just the builder's own report

🤖 Generated with Claude Code

@vanceingalls
vanceingalls force-pushed the fix/prompt-guide-validation-bugs branch from 40d3095 to 745168e Compare July 9, 2026 18:59
@vanceingalls vanceingalls changed the title fix(skills): resolve prompt-guide validation findings across skill pipelines docs(skills): text corrections from prompt-guide validation Jul 9, 2026
@vanceingalls
vanceingalls force-pushed the fix/prompt-guide-validation-bugs branch from 745168e to 6fba438 Compare July 10, 2026 00:40
@vanceingalls vanceingalls changed the title docs(skills): text corrections from prompt-guide validation docs: multi-page Prompt Guide + text corrections from validation Jul 10, 2026
vanceingalls and others added 8 commits July 9, 2026 22:21
Documentation-only updates surfaced by the prompt-guide validation
campaign. The behavior fixes from the same campaign are in a separate
PR (pipeline fixes); Tier 3 block bugs are tracked in #2107.

- hyperframes-core SKILL.md: new "First-pass lint gotchas" subsection —
  the root composition element must carry data-start="0"
  (root_composition_missing_data_start), and initial states belong in
  gsap.fromTo, never a CSS transform paired with a GSAP tween on the
  same property (gsap_css_transform_conflict). Both were guaranteed
  first-build lint failures for agents writing compositions cold.
- media-use SKILL.md: "Weak local-model defaults" row corrected — local
  Kokoro TTS is the free default with HeyGen as the paid upsell (was
  described backwards), and bg-removal runs via the hyperframes CLI.
- docs/concepts/compositions.mdx: document that data-composition-src
  paths resolve relative to the project root, not the referencing file.
- gsap-transforms-and-perf.md: runtime-created SVG (createElementNS)
  has no reliable center pivot — draw geometry at local (0,0) inside a
  positioning <g> so scale/rotation pivot on the shape's middle.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Splits guides/prompting into a Prompt Guide nav group (overview + Fundamentals
+ Making it look good, 11 pages) with a redirect from the old URL. Applies
research-validated upgrades: beat content formula, before/after prompt rewrites
with engine rationale, single-variable iteration moves, absolute-target
calibration, camera/depth/pacing vocabulary, prerequisites gate.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Adds 18 pages completing the Prompt Guide expansion (phases 2-4): six
video-type pages seeded by the verified example prompts, and twelve
feature pages giving prompting guidance for surfaces the docs implied
but never covered (transitions, caption styles, overlays, code blocks,
data/maps, VFX, rendering/output, editing existing videos, media/audio,
variables, runtimes/3D, design systems). All block/component/skill names
grounded against the catalog and skills; render pairing deferred.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Runs validation builds for the primary prompt on every new feature page
(all pass lint/validate/render) and applies the fixes they surfaced:
lower-third exit-length note, block-adaptation framing on the anatomy
technique slot, code-typing per-character wording, caption-component
demo-content note, map determinism/merge-at-source notes, device-mockup
demo-UI expectation, variables img clarification. Embeds 29 unedited
renders next to their prompts (HeyGenVerse-hosted), including a
default-vs-overridden pair demonstrating variables.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Moves all 28 example/validation renders to the docs' canonical media
host (s3://heygen-public via scripts/upload-docs-images.sh) and points
every embed at static.heygen.ai instead of HeyGenVerse asset URLs.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…eness

Five-way review of the section against docs.json, catalog pages, and
skills. Fixes: stale /hyperframes-media skill row (real name /media-use)
plus missing music-to-video and slideshow workflow rows; caption
identity misattributions (keynote/documentary are scene-embedded, stomp
carries no rail); prompts violating the guide's own ambient-idle rule;
grounded keying rationale (u2net_human_seg); broken forward references;
nested-backtick code spans; brand casing and frontmatter dash
consistency throughout.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ked specs, measured motion

Validates 16 more published prompts end-to-end (variants across every
video type, caption styles, overlays with proven alpha, code diff and
highlight, edit verbs against the real attribute map, a generated-avatar
talking-head through embedded-captions, a presented slideshow deck) and
fixes every prompt flaw the builds surfaced. Adds keyword-to-render
grids for the easing, camera, and marker vocabulary; two more worked
visual specs with renders; a measured before/after pair proving the
motion grammar (frozen frames vs all-alive, 211KB vs 2.5MB); before/
after render pairs on editing and generated-artwork pages; and proof
renders on the overview.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…th zero prompting coverage

Every other creation workflow gets either a dedicated page or an
explicit routing/contrast section inside a related one (website-to-
video inside product-launch.mdx, slideshow inside music-and-
slideshows.mdx). /remotion-to-hyperframes had neither — its only
mention anywhere in the 29-page guide was one line in overview.mdx's
install table.

Covers what to hand the agent (the exact source file, since a Remotion
project can register several Compositions), the one-way/no-reverse-
export scope, the lint-blocker categories that make the skill refuse
rather than approximate (useState/useEffect state machines, third-
party UI kits), and why SSIM validation against the Remotion original
is part of the deliverable, not optional. Added to the "By video type"
nav group in docs.json.

Co-Authored-By: Claude Opus <noreply@anthropic.com>
…made-but-deterministic feel

Learned from a strong example prompt (not reused verbatim — different
subject, same technique): a stop-motion/hand-animated look wants
irregular timing, but true unseeded randomness breaks HyperFrames'
determinism guarantee (same seek must always render the same frame).
The correct pattern is a PRNG seeded once at composition start, stepping
elements between held positions rather than tweening continuously —
distinct from rule 1's continuous ambient idle, which is a different
tool for a different texture.

Kept separate from "The grammar, measured" (rules 1-6, empirically
videoed) since there's no rendered proof for rule 7 yet — the new
section and example are illustrative, not claimed as verified.

Co-Authored-By: Claude Opus <noreply@anthropic.com>
…licts

Two real conflicts:

- docs/guides/prompting.mdx: modify/delete. This branch already deleted
  it (383dd35, replaced by the docs/prompting/* multi-page structure);
  main separately fixed one line in the old file (cf7c1d7: lint+validate
  -> the new consolidated `check` command). Kept the deletion — a
  redirect to /prompting/overview already exists in docs.json — and
  ported the same check-command fix forward into the two new-structure
  pages that still had the stale lint+validate phrasing
  (examples.mdx, rules-and-anti-patterns.mdx), so main's fix isn't lost.

- skills-manifest.json: auto-generated, regenerated fresh via
  packages/cli/scripts/gen-skills-manifest.ts rather than hand-resolving
  the JSON conflict markers.

Everything else auto-merged cleanly (no conflicts) — this pulls in
main's independent work since the branch diverged (media-use v2, the
check command consolidation, studio timeline updates, etc).

Co-Authored-By: Claude Opus <noreply@anthropic.com>
vanceingalls and others added 15 commits July 22, 2026 11:59
…mandate note

Level 2 (anatomy, specification-dial, vocabulary, visual-specs, examples)
gets entry/exit bridges tying it into the Level 1 -> Level 3 arc, plus a
short note on the composition-structure mandate (0aaac7a / PR #2599)
showing the framework enforces its own version of the prompt skeleton.
All existing prompts, renders, and tables are untouched.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Add entry bridges (each naming a specific Level 1-3 artifact the
capability slots into) and literal exit bridges across the 7 Level 4
Substance pages, per the novice-to-advanced restructure plan.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@vanceingalls vanceingalls changed the title docs: multi-page Prompt Guide + text corrections from validation docs: Prompt Guide as a novice-to-capstone arc + text corrections from validation Jul 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant