zilmate 1.9.9 → 1.10.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agents/skills/ad-creative/SKILL.md +362 -0
- package/.agents/skills/ad-creative/evals/evals.json +90 -0
- package/.agents/skills/ad-creative/references/generative-tools.md +637 -0
- package/.agents/skills/ad-creative/references/platform-specs.md +213 -0
- package/.agents/skills/ai-seo/SKILL.md +489 -0
- package/.agents/skills/ai-seo/evals/evals.json +90 -0
- package/.agents/skills/ai-seo/references/content-patterns.md +285 -0
- package/.agents/skills/ai-seo/references/content-types.md +71 -0
- package/.agents/skills/ai-seo/references/okf.md +104 -0
- package/.agents/skills/ai-seo/references/platform-ranking-factors.md +154 -0
- package/.agents/skills/clerk-backend-api/SKILL.md +426 -0
- package/.agents/skills/clerk-backend-api/evals/evals.json +87 -0
- package/.agents/skills/clerk-backend-api/scripts/api-specs-context.sh +30 -0
- package/.agents/skills/clerk-backend-api/scripts/execute-request.sh +88 -0
- package/.agents/skills/clerk-backend-api/scripts/extract-endpoint-detail.sh +165 -0
- package/.agents/skills/clerk-backend-api/scripts/extract-tag-endpoints.sh +208 -0
- package/.agents/skills/clerk-backend-api/scripts/extract-tags.js +14 -0
- package/.agents/skills/copy-editing/SKILL.md +457 -0
- package/.agents/skills/copy-editing/evals/evals.json +89 -0
- package/.agents/skills/copy-editing/references/checklist.md +66 -0
- package/.agents/skills/copy-editing/references/content-refresh.md +38 -0
- package/.agents/skills/copy-editing/references/plain-english-alternatives.md +394 -0
- package/.agents/skills/hyperframes/SKILL.md +163 -0
- package/.agents/skills/hyperframes-cli/SKILL.md +109 -0
- package/.agents/skills/hyperframes-cli/references/doctor-browser.md +45 -0
- package/.agents/skills/hyperframes-cli/references/init-and-scaffold.md +51 -0
- package/.agents/skills/hyperframes-cli/references/lambda.md +132 -0
- package/.agents/skills/hyperframes-cli/references/lint-validate-inspect.md +121 -0
- package/.agents/skills/hyperframes-cli/references/preview-render.md +109 -0
- package/.agents/skills/hyperframes-cli/references/upgrade-info-misc.md +75 -0
- package/.agents/skills/hyperframes-media/SKILL.md +97 -0
- package/.agents/skills/hyperframes-media/assets/sfx/CREDITS.md +35 -0
- package/.agents/skills/hyperframes-media/assets/sfx/manifest.json +97 -0
- package/.agents/skills/hyperframes-media/references/bgm.md +72 -0
- package/.agents/skills/hyperframes-media/references/captions/authoring.md +159 -0
- package/.agents/skills/hyperframes-media/references/captions/motion.md +87 -0
- package/.agents/skills/hyperframes-media/references/captions/transcript-handling.md +97 -0
- package/.agents/skills/hyperframes-media/references/remove-background.md +143 -0
- package/.agents/skills/hyperframes-media/references/requirements.md +29 -0
- package/.agents/skills/hyperframes-media/references/sfx.md +42 -0
- package/.agents/skills/hyperframes-media/references/transcribe.md +52 -0
- package/.agents/skills/hyperframes-media/references/tts-to-captions.md +24 -0
- package/.agents/skills/hyperframes-media/references/tts.md +135 -0
- package/.agents/skills/hyperframes-media/scripts/audio.mjs +282 -0
- package/.agents/skills/hyperframes-media/scripts/heygen-tts.mjs +121 -0
- package/.agents/skills/hyperframes-media/scripts/lib/bgm.mjs +235 -0
- package/.agents/skills/hyperframes-media/scripts/lib/heygen.mjs +131 -0
- package/.agents/skills/hyperframes-media/scripts/lib/sfx.mjs +128 -0
- package/.agents/skills/hyperframes-media/scripts/lib/tts.mjs +220 -0
- package/.agents/skills/hyperframes-media/scripts/lyria-recipe.py +128 -0
- package/.agents/skills/hyperframes-media/scripts/wait-bgm.mjs +167 -0
- package/.agents/skills/hyperframes-registry/SKILL.md +101 -0
- package/.agents/skills/hyperframes-registry/examples/add-block.md +51 -0
- package/.agents/skills/hyperframes-registry/examples/add-component.md +73 -0
- package/.agents/skills/hyperframes-registry/references/contributing.md +166 -0
- package/.agents/skills/hyperframes-registry/references/demo-html-pattern.md +54 -0
- package/.agents/skills/hyperframes-registry/references/discovery.md +215 -0
- package/.agents/skills/hyperframes-registry/references/install-locations.md +45 -0
- package/.agents/skills/hyperframes-registry/references/templates.md +417 -0
- package/.agents/skills/hyperframes-registry/references/wiring-blocks.md +61 -0
- package/.agents/skills/hyperframes-registry/references/wiring-components.md +39 -0
- package/.agents/skills/marketing-psychology/SKILL.md +455 -0
- package/.agents/skills/marketing-psychology/evals/evals.json +88 -0
- package/.agents/skills/mintlify/SKILL.md +328 -0
- package/.agents/skills/product-launch-video/SKILL.md +206 -0
- package/.agents/skills/product-launch-video/references/cut-catalog.md +220 -0
- package/.agents/skills/product-launch-video/references/motion-language.md +156 -0
- package/.agents/skills/product-launch-video/references/story-design.md +373 -0
- package/.agents/skills/product-launch-video/references/visual-design.md +126 -0
- package/.agents/skills/product-launch-video/scripts/assemble-index.mjs +570 -0
- package/.agents/skills/product-launch-video/scripts/audio.mjs +253 -0
- package/.agents/skills/product-launch-video/scripts/build-frame.mjs +536 -0
- package/.agents/skills/product-launch-video/scripts/captions.mjs +508 -0
- package/.agents/skills/product-launch-video/scripts/lib/assets.mjs +55 -0
- package/.agents/skills/product-launch-video/scripts/lib/dimensions.mjs +45 -0
- package/.agents/skills/product-launch-video/scripts/lib/storyboard.mjs +249 -0
- package/.agents/skills/product-launch-video/scripts/lib/tokens.mjs +204 -0
- package/.agents/skills/product-launch-video/scripts/lib/transition-registry.mjs +38 -0
- package/.agents/skills/product-launch-video/scripts/lib/transitions.json +71 -0
- package/.agents/skills/product-launch-video/scripts/stage-assets.mjs +39 -0
- package/.agents/skills/product-launch-video/scripts/transitions.mjs +320 -0
- package/.agents/skills/product-launch-video/sub-agents/frame-worker.md +74 -0
- package/.agents/skills/prompt-engineering-patterns/SKILL.md +144 -0
- package/.agents/skills/prompt-engineering-patterns/assets/few-shot-examples.json +106 -0
- package/.agents/skills/prompt-engineering-patterns/assets/prompt-template-library.md +264 -0
- package/.agents/skills/prompt-engineering-patterns/references/chain-of-thought.md +412 -0
- package/.agents/skills/prompt-engineering-patterns/references/details.md +338 -0
- package/.agents/skills/prompt-engineering-patterns/references/few-shot-learning.md +386 -0
- package/.agents/skills/prompt-engineering-patterns/references/prompt-optimization.md +428 -0
- package/.agents/skills/prompt-engineering-patterns/references/prompt-templates.md +484 -0
- package/.agents/skills/prompt-engineering-patterns/references/system-prompts.md +195 -0
- package/.agents/skills/prompt-engineering-patterns/scripts/optimize-prompt.py +279 -0
- package/.agents/skills/remotion-to-hyperframes/SKILL.md +127 -0
- package/.agents/skills/remotion-to-hyperframes/assets/.gitkeep +0 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/run.sh +249 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/README.md +41 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/expected.json +26 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/hf-src/index.html +61 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/package.json +14 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/remotion.config.ts +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/src/Root.tsx +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/src/TitleCard.tsx +34 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/src/index.ts +4 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-1-title-card/remotion-src/tsconfig.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/README.md +54 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/expected.json +29 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/hf-src/index.html +118 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/package.json +14 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/remotion.config.ts +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/src/MultiScene.tsx +105 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/src/Root.tsx +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/src/index.ts +4 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/remotion-src/tsconfig.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-2-multi-scene/setup.sh +34 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/README.md +85 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/expected.json +41 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/hf-src/index.html +269 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/package.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/remotion.config.ts +13 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/Root.tsx +27 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/Stargazed.tsx +37 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/components/AnimatedNumber.tsx +23 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/components/StatCard.tsx +59 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/components/UnderlinedText.tsx +47 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/index.ts +4 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/scenes/OutroScene.tsx +18 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/scenes/StatsScene.tsx +34 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/src/scenes/TitleScene.tsx +55 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-3-data-driven/remotion-src/tsconfig.json +15 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/README.md +51 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/01-use-state.tsx +29 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/02-use-effect-deps.tsx +29 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/03-async-metadata.tsx +39 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/04-third-party-react.tsx +30 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/05-lambda-config.tsx +38 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/06-warnings-only.tsx +36 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/07-custom-hook.tsx +28 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/cases/08-mixed.tsx +41 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/expected.json +85 -0
- package/.agents/skills/remotion-to-hyperframes/assets/test-corpus/tier-4-escape-hatch/validate.sh +110 -0
- package/.agents/skills/remotion-to-hyperframes/references/api-map.md +142 -0
- package/.agents/skills/remotion-to-hyperframes/references/escape-hatch.md +115 -0
- package/.agents/skills/remotion-to-hyperframes/references/eval.md +140 -0
- package/.agents/skills/remotion-to-hyperframes/references/fonts.md +112 -0
- package/.agents/skills/remotion-to-hyperframes/references/limitations.md +136 -0
- package/.agents/skills/remotion-to-hyperframes/references/lottie.md +121 -0
- package/.agents/skills/remotion-to-hyperframes/references/media.md +149 -0
- package/.agents/skills/remotion-to-hyperframes/references/parameters.md +167 -0
- package/.agents/skills/remotion-to-hyperframes/references/sequencing.md +195 -0
- package/.agents/skills/remotion-to-hyperframes/references/timing.md +165 -0
- package/.agents/skills/remotion-to-hyperframes/references/transitions.md +114 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/.gitkeep +0 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/frame_strip.sh +107 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/lint_source.py +358 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/render_diff.sh +103 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/tests/fixtures/blocker.tsx +50 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/tests/fixtures/clean.tsx +46 -0
- package/.agents/skills/remotion-to-hyperframes/scripts/tests/smoke.sh +90 -0
- package/.agents/skills/seo-audit/SKILL.md +497 -0
- package/.agents/skills/seo-audit/evals/evals.json +136 -0
- package/.agents/skills/seo-audit/references/ai-writing-detection.md +200 -0
- package/.agents/skills/seo-audit/references/international-seo.md +230 -0
- package/README.md +4 -2
- package/SDK.md +64 -1
- package/dist/agents/coding.agent.d.ts +558 -0
- package/dist/agents/coding.agent.d.ts.map +1 -1
- package/dist/agents/coding.agent.js +8 -0
- package/dist/agents/coding.agent.js.map +1 -1
- package/dist/agents/developer-helper.agent.d.ts +712 -0
- package/dist/agents/developer-helper.agent.d.ts.map +1 -1
- package/dist/agents/developer-helper.agent.js +6 -0
- package/dist/agents/developer-helper.agent.js.map +1 -1
- package/dist/agents/docs-research.agent.d.ts +8 -0
- package/dist/agents/docs-research.agent.d.ts.map +1 -1
- package/dist/agents/finance.agent.d.ts +8 -0
- package/dist/agents/finance.agent.d.ts.map +1 -1
- package/dist/agents/manager.d.ts +837 -2
- package/dist/agents/manager.d.ts.map +1 -1
- package/dist/agents/manager.js +28 -0
- package/dist/agents/manager.js.map +1 -1
- package/dist/agents/security.agent.d.ts +165 -3
- package/dist/agents/security.agent.d.ts.map +1 -1
- package/dist/agents/security.agent.js +3 -0
- package/dist/agents/security.agent.js.map +1 -1
- package/dist/agents/swarm/main.js +1 -1
- package/dist/agents/swarm/main.js.map +1 -1
- package/dist/agents/swarm/registry.d.ts.map +1 -1
- package/dist/agents/swarm/registry.js +232 -26
- package/dist/agents/swarm/registry.js.map +1 -1
- package/dist/cli/doctor.d.ts +14 -0
- package/dist/cli/doctor.d.ts.map +1 -1
- package/dist/cli/doctor.js +91 -0
- package/dist/cli/doctor.js.map +1 -1
- package/dist/cli/menu.d.ts.map +1 -1
- package/dist/cli/menu.js +102 -0
- package/dist/cli/menu.js.map +1 -1
- package/dist/cli/setup.d.ts +10 -0
- package/dist/cli/setup.d.ts.map +1 -1
- package/dist/cli/setup.js +178 -0
- package/dist/cli/setup.js.map +1 -1
- package/dist/cli/swarm.d.ts +1 -0
- package/dist/cli/swarm.d.ts.map +1 -1
- package/dist/cli/swarm.js +47 -8
- package/dist/cli/swarm.js.map +1 -1
- package/dist/cli/theme.d.ts +0 -24
- package/dist/cli/theme.d.ts.map +1 -1
- package/dist/cli/theme.js +6 -2
- package/dist/cli/theme.js.map +1 -1
- package/dist/config/env.d.ts +10 -0
- package/dist/config/env.d.ts.map +1 -1
- package/dist/config/env.js +38 -17
- package/dist/config/env.js.map +1 -1
- package/dist/index.js +96 -5
- package/dist/index.js.map +1 -1
- package/dist/jobs/trigger-orchestrator.d.ts +5 -1
- package/dist/jobs/trigger-orchestrator.d.ts.map +1 -1
- package/dist/jobs/trigger-orchestrator.js +29 -9
- package/dist/jobs/trigger-orchestrator.js.map +1 -1
- package/dist/jobs/trigger-router.d.ts.map +1 -1
- package/dist/jobs/trigger-router.js +3 -2
- package/dist/jobs/trigger-router.js.map +1 -1
- package/dist/memory/corporate-wiki.d.ts +15 -0
- package/dist/memory/corporate-wiki.d.ts.map +1 -0
- package/dist/memory/corporate-wiki.js +152 -0
- package/dist/memory/corporate-wiki.js.map +1 -0
- package/dist/memory/scratchpad.d.ts +2 -0
- package/dist/memory/scratchpad.d.ts.map +1 -1
- package/dist/memory/scratchpad.js +27 -0
- package/dist/memory/scratchpad.js.map +1 -1
- package/dist/observability/doctor.d.ts.map +1 -1
- package/dist/observability/doctor.js +12 -4
- package/dist/observability/doctor.js.map +1 -1
- package/dist/observability/traces.d.ts +72 -0
- package/dist/observability/traces.d.ts.map +1 -0
- package/dist/observability/traces.js +1134 -0
- package/dist/observability/traces.js.map +1 -0
- package/dist/runtime/swarm.d.ts +1 -1
- package/dist/runtime/swarm.d.ts.map +1 -1
- package/dist/runtime/swarm.js +54 -25
- package/dist/runtime/swarm.js.map +1 -1
- package/dist/safety/approvals.d.ts +2 -2
- package/dist/safety/approvals.d.ts.map +1 -1
- package/dist/safety/approvals.js +47 -1
- package/dist/safety/approvals.js.map +1 -1
- package/dist/safety/redaction.d.ts.map +1 -1
- package/dist/safety/redaction.js +10 -0
- package/dist/safety/redaction.js.map +1 -1
- package/dist/tools/cloud.tool.d.ts +394 -0
- package/dist/tools/cloud.tool.d.ts.map +1 -0
- package/dist/tools/cloud.tool.js +784 -0
- package/dist/tools/cloud.tool.js.map +1 -0
- package/dist/tools/computer-use.tool.d.ts +2 -2
- package/dist/tools/corporate-wiki.tool.d.ts +22 -0
- package/dist/tools/corporate-wiki.tool.d.ts.map +1 -0
- package/dist/tools/corporate-wiki.tool.js +43 -0
- package/dist/tools/corporate-wiki.tool.js.map +1 -0
- package/dist/tools/devops.tool.d.ts +162 -0
- package/dist/tools/devops.tool.d.ts.map +1 -0
- package/dist/tools/devops.tool.js +377 -0
- package/dist/tools/devops.tool.js.map +1 -0
- package/dist/tools/multimedia.tool.d.ts +126 -0
- package/dist/tools/multimedia.tool.d.ts.map +1 -0
- package/dist/tools/multimedia.tool.js +533 -0
- package/dist/tools/multimedia.tool.js.map +1 -0
- package/dist/tools/osint.tool.d.ts +6 -6
- package/dist/tools/sandbox-dev.tool.d.ts +15 -0
- package/dist/tools/sandbox-dev.tool.d.ts.map +1 -0
- package/dist/tools/sandbox-dev.tool.js +146 -0
- package/dist/tools/sandbox-dev.tool.js.map +1 -0
- package/dist/tools/scratchpad.tool.d.ts +8 -0
- package/dist/tools/scratchpad.tool.d.ts.map +1 -1
- package/dist/tools/scratchpad.tool.js +40 -1
- package/dist/tools/scratchpad.tool.js.map +1 -1
- package/dist/tools/setup-assistant.tool.d.ts +1 -1
- package/dist/tools/swarm-ops.tool.d.ts +14 -0
- package/dist/tools/swarm-ops.tool.d.ts.map +1 -1
- package/dist/tools/swarm-ops.tool.js +47 -0
- package/dist/tools/swarm-ops.tool.js.map +1 -1
- package/dist/tools/sysops.tool.d.ts +157 -0
- package/dist/tools/sysops.tool.d.ts.map +1 -0
- package/dist/tools/sysops.tool.js +643 -0
- package/dist/tools/sysops.tool.js.map +1 -0
- package/dist/voice/deepgram.d.ts.map +1 -1
- package/dist/voice/deepgram.js +30 -2
- package/dist/voice/deepgram.js.map +1 -1
- package/package.json +8 -1
- package/scripts/release-github.mjs +23 -16
|
@@ -0,0 +1,328 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: mintlify
|
|
3
|
+
description: Build and maintain documentation sites with Mintlify. Use when creating docs pages, configuring navigation, adding components, or setting up API references.
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: Requires Node.js for CLI. Works with any Git-based workflow.
|
|
6
|
+
metadata:
|
|
7
|
+
author: mintlify
|
|
8
|
+
version: "1.0"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Mintlify best practices
|
|
12
|
+
|
|
13
|
+
**Always consult [mintlify.com/docs](https://mintlify.com/docs) for components, configuration, and latest features.**
|
|
14
|
+
|
|
15
|
+
If you are not already connected to the Mintlify MCP server, https://mintlify.com/docs/mcp, add it so that you can search more efficiently.
|
|
16
|
+
|
|
17
|
+
**Always** favor searching the current Mintlify documentation over whatever is in your training data about Mintlify.
|
|
18
|
+
|
|
19
|
+
Mintlify is a documentation platform that transforms MDX files into documentation sites. Configure site-wide settings in the `docs.json` file, write content in MDX with YAML frontmatter, and favor built-in components over custom components.
|
|
20
|
+
|
|
21
|
+
Full schema at [mintlify.com/docs.json](https://mintlify.com/docs.json).
|
|
22
|
+
|
|
23
|
+
## Before you write
|
|
24
|
+
|
|
25
|
+
### Understand the project
|
|
26
|
+
|
|
27
|
+
Read `docs.json` in the project root. This file defines the entire site: navigation structure, theme, colors, links, API and specs.
|
|
28
|
+
|
|
29
|
+
Understanding the project tells you:
|
|
30
|
+
|
|
31
|
+
- What pages exist and how they're organized
|
|
32
|
+
- What navigation groups are used (and their naming conventions)
|
|
33
|
+
- How the site navigation is structured
|
|
34
|
+
- What theme and configuration the site uses
|
|
35
|
+
|
|
36
|
+
### Check for existing content
|
|
37
|
+
|
|
38
|
+
Search the docs before creating new pages. You may need to:
|
|
39
|
+
- Update an existing page instead of creating a new one
|
|
40
|
+
- Add a section to an existing page
|
|
41
|
+
- Link to existing content rather than duplicating
|
|
42
|
+
|
|
43
|
+
### Read surrounding content
|
|
44
|
+
|
|
45
|
+
Before writing, read 2-3 similar pages to understand the site's voice, structure, formatting conventions, and level of detail.
|
|
46
|
+
|
|
47
|
+
### Understand Mintlify components
|
|
48
|
+
|
|
49
|
+
Review the Mintlify [components](https://www.mintlify.com/docs/components) to select and use any relevant components for the documentation request that you are working on.
|
|
50
|
+
|
|
51
|
+
## Quick reference
|
|
52
|
+
|
|
53
|
+
### CLI commands
|
|
54
|
+
- `npm i -g mint` - Install the Mintlify CLI
|
|
55
|
+
- `mint dev` - Local preview at localhost:3000
|
|
56
|
+
- `mint broken-links` - Check internal links
|
|
57
|
+
- `mint a11y` - Check for accessibility issues in content
|
|
58
|
+
- `mint validate` - Validate documentation builds
|
|
59
|
+
|
|
60
|
+
### Required files
|
|
61
|
+
- `docs.json` - Site configuration (navigation, theme, integrations, etc.). See [global settings](https://mintlify.com/docs/settings/global) for all options.
|
|
62
|
+
- `*.mdx` files - Documentation pages with YAML frontmatter
|
|
63
|
+
|
|
64
|
+
### Example file structure
|
|
65
|
+
```
|
|
66
|
+
project/
|
|
67
|
+
├── docs.json # Site configuration
|
|
68
|
+
├── introduction.mdx
|
|
69
|
+
├── quickstart.mdx
|
|
70
|
+
├── guides/
|
|
71
|
+
│ └── example.mdx
|
|
72
|
+
├── openapi.yml # API specification
|
|
73
|
+
├── images/ # Static assets
|
|
74
|
+
│ └── example.png
|
|
75
|
+
└── snippets/ # Reusable components
|
|
76
|
+
└── component.jsx
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Page frontmatter
|
|
80
|
+
|
|
81
|
+
Every page requires `title` in its frontmatter. Include `description` for SEO and navigation.
|
|
82
|
+
|
|
83
|
+
```yaml
|
|
84
|
+
---
|
|
85
|
+
title: "Clear, descriptive title"
|
|
86
|
+
description: "Concise summary for SEO and navigation."
|
|
87
|
+
---
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Optional frontmatter fields:
|
|
91
|
+
- `sidebarTitle`: Short title for sidebar navigation.
|
|
92
|
+
- `icon`: Lucide or Font Awesome icon name, URL, or file path.
|
|
93
|
+
- `tag`: Label next to the page title in the sidebar (for example, "NEW").
|
|
94
|
+
- `mode`: Page layout mode (`default`, `wide`, `custom`).
|
|
95
|
+
- `keywords`: Array of terms related to the page content for local search and SEO.
|
|
96
|
+
- Any custom YAML fields for use with personalization or conditional content.
|
|
97
|
+
|
|
98
|
+
## File conventions
|
|
99
|
+
|
|
100
|
+
- Match existing naming patterns in the directory
|
|
101
|
+
- If there are no existing files or inconsistent file naming patterns, use kebab-case: `getting-started.mdx`, `api-reference.mdx`
|
|
102
|
+
- Use root-relative paths without file extensions for internal links: `/getting-started/quickstart`
|
|
103
|
+
- Do not use relative paths (`../`) or absolute URLs for internal pages
|
|
104
|
+
- When you create a new page, add it to `docs.json` navigation or it won't appear in the sidebar
|
|
105
|
+
|
|
106
|
+
## Organize content
|
|
107
|
+
|
|
108
|
+
When a user asks about anything related to site-wide configurations, start by understanding the [global settings](https://www.mintlify.com/docs/organize/settings). See if a setting in the `docs.json` file can be updated to achieve what the user wants.
|
|
109
|
+
|
|
110
|
+
### Navigation
|
|
111
|
+
|
|
112
|
+
The `navigation` property in `docs.json` controls site structure. Choose one primary pattern at the root level, then nest others within it.
|
|
113
|
+
|
|
114
|
+
**Choose your primary pattern:**
|
|
115
|
+
|
|
116
|
+
| Pattern | When to use |
|
|
117
|
+
|---------|-------------|
|
|
118
|
+
| **Groups** | Default. Single audience, straightforward hierarchy |
|
|
119
|
+
| **Tabs** | Distinct sections with different audiences (Guides vs API Reference) or content types |
|
|
120
|
+
| **Anchors** | Want persistent section links at sidebar top. Good for separating docs from external resources |
|
|
121
|
+
| **Dropdowns** | Multiple doc sections users switch between, but not distinct enough for tabs |
|
|
122
|
+
| **Products** | Multi-product company with separate documentation per product |
|
|
123
|
+
| **Versions** | Maintaining docs for multiple API/product versions simultaneously |
|
|
124
|
+
| **Languages** | Localized content |
|
|
125
|
+
|
|
126
|
+
**Within your primary pattern:**
|
|
127
|
+
|
|
128
|
+
- **Groups** - Organize related pages. Can nest groups within groups, but keep hierarchy shallow
|
|
129
|
+
- **Menus** - Add dropdown navigation within tabs for quick jumps to specific pages
|
|
130
|
+
- **`expanded: false`** - Collapse nested groups by default. Use for reference sections users browse selectively
|
|
131
|
+
- **`openapi`** - Auto-generate pages from OpenAPI spec. Add at group/tab level to inherit
|
|
132
|
+
|
|
133
|
+
**Common combinations:**
|
|
134
|
+
- Tabs containing groups (most common for docs with API reference)
|
|
135
|
+
- Products containing tabs (multi-product SaaS)
|
|
136
|
+
- Versions containing tabs (versioned API docs)
|
|
137
|
+
- Anchors containing groups (simple docs with external resource links)
|
|
138
|
+
|
|
139
|
+
### Links and paths
|
|
140
|
+
|
|
141
|
+
- **Internal links:** Root-relative, no extension: `/getting-started/quickstart`
|
|
142
|
+
- **Images:** Store in `/images`, reference as `/images/example.png`
|
|
143
|
+
- **External links:** Use full URLs, they open in new tabs automatically
|
|
144
|
+
|
|
145
|
+
## Customize docs sites
|
|
146
|
+
|
|
147
|
+
**What to customize where:**
|
|
148
|
+
- **Brand colors, fonts, logo** → `docs.json`. See [global settings](https://mintlify.com/docs/settings/global)
|
|
149
|
+
- **Component styling, layout tweaks** → `custom.css` at project root
|
|
150
|
+
- **Dark mode** → Enabled by default. Only disable with `"appearance": "light"` in `docs.json` if brand requires it
|
|
151
|
+
|
|
152
|
+
Start with `docs.json`. Only add `custom.css` when you need styling that config doesn't support.
|
|
153
|
+
|
|
154
|
+
## Write content
|
|
155
|
+
|
|
156
|
+
### Components
|
|
157
|
+
|
|
158
|
+
The [components overview](https://mintlify.com/docs/components) organizes all components by purpose: structure content, draw attention, show/hide content, document APIs, link to pages, and add visual context. Start there to find the right component.
|
|
159
|
+
|
|
160
|
+
**Common decision points:**
|
|
161
|
+
|
|
162
|
+
| Need | Use |
|
|
163
|
+
|------|-----|
|
|
164
|
+
| Hide optional details | `<Accordion>` |
|
|
165
|
+
| Long code examples | `<Expandable>` |
|
|
166
|
+
| User chooses one option | `<Tabs>` |
|
|
167
|
+
| Linked navigation cards | `<Card>` in `<Columns>` |
|
|
168
|
+
| Sequential instructions | `<Steps>` |
|
|
169
|
+
| Code in multiple languages | `<CodeGroup>` |
|
|
170
|
+
| API parameters | `<ParamField>` |
|
|
171
|
+
| API response fields | `<ResponseField>` |
|
|
172
|
+
|
|
173
|
+
**Callouts by severity:**
|
|
174
|
+
- `<Note>` - Supplementary info, safe to skip
|
|
175
|
+
- `<Info>` - Helpful context such as permissions
|
|
176
|
+
- `<Tip>` - Recommendations or best practices
|
|
177
|
+
- `<Warning>` - Potentially destructive actions
|
|
178
|
+
- `<Check>` - Success confirmation
|
|
179
|
+
|
|
180
|
+
### Reusable content
|
|
181
|
+
|
|
182
|
+
**When to use snippets:**
|
|
183
|
+
- Exact content appears on more than one page
|
|
184
|
+
- Complex components you want to maintain in one place
|
|
185
|
+
- Shared content across teams/repos
|
|
186
|
+
|
|
187
|
+
**When NOT to use snippets:**
|
|
188
|
+
- Slight variations needed per page (leads to complex props)
|
|
189
|
+
|
|
190
|
+
Import snippets with `import { Component } from "/path/to/snippet-name.jsx"`.
|
|
191
|
+
|
|
192
|
+
## Writing standards
|
|
193
|
+
|
|
194
|
+
### Voice and structure
|
|
195
|
+
|
|
196
|
+
- Second-person voice ("you")
|
|
197
|
+
- Active voice, direct language
|
|
198
|
+
- Sentence case for headings ("Getting started", not "Getting Started")
|
|
199
|
+
- Sentence case for code block titles ("Expandable example", not "Expandable Example")
|
|
200
|
+
- Lead with context: explain what something is before how to use it
|
|
201
|
+
- Prerequisites at the start of procedural content
|
|
202
|
+
|
|
203
|
+
### What to avoid
|
|
204
|
+
|
|
205
|
+
**Never use:**
|
|
206
|
+
- Marketing language ("powerful", "seamless", "robust", "cutting-edge")
|
|
207
|
+
- Filler phrases ("it's important to note", "in order to")
|
|
208
|
+
- Excessive conjunctions ("moreover", "furthermore", "additionally")
|
|
209
|
+
- Editorializing ("obviously", "simply", "just", "easily")
|
|
210
|
+
|
|
211
|
+
**Watch for AI-typical patterns:**
|
|
212
|
+
- Overly formal or stilted phrasing
|
|
213
|
+
- Unnecessary repetition of concepts
|
|
214
|
+
- Generic introductions that don't add value
|
|
215
|
+
- Concluding summaries that restate what was just said
|
|
216
|
+
|
|
217
|
+
### Formatting
|
|
218
|
+
|
|
219
|
+
- All code blocks must have language tags
|
|
220
|
+
- All images and media must have descriptive alt text
|
|
221
|
+
- Use bold and italics only when they serve the reader's understanding--never use text styling just for decoration
|
|
222
|
+
- No decorative formatting or emoji
|
|
223
|
+
|
|
224
|
+
### Code examples
|
|
225
|
+
|
|
226
|
+
- Keep examples simple and practical
|
|
227
|
+
- Use realistic values (not "foo" or "bar")
|
|
228
|
+
- One clear example is better than multiple variations
|
|
229
|
+
- Test that code works before including it
|
|
230
|
+
|
|
231
|
+
## Document APIs
|
|
232
|
+
|
|
233
|
+
**Choose your approach:**
|
|
234
|
+
- **Have an OpenAPI spec?** → Add to `docs.json` with `"openapi": ["openapi.yaml"]`. Pages auto-generate. Reference in navigation as `GET /endpoint`
|
|
235
|
+
- **No spec?** → Write endpoints manually with `api: "POST /users"` in frontmatter. More work but full control
|
|
236
|
+
- **Hybrid** → Use OpenAPI for most endpoints, manual pages for complex workflows
|
|
237
|
+
|
|
238
|
+
Encourage users to generate endpoint pages from an OpenAPI spec. It is the most efficient and easiest to maintain option.
|
|
239
|
+
|
|
240
|
+
## Deploy
|
|
241
|
+
|
|
242
|
+
Mintlify deploys automatically when changes are pushed to the connected Git repository.
|
|
243
|
+
|
|
244
|
+
**What agents can configure:**
|
|
245
|
+
- **Redirects** → Add to `docs.json` with `"redirects": [{"source": "/old", "destination": "/new"}]`
|
|
246
|
+
- **SEO indexing** → Control with `"seo": {"indexing": "all"}` to include hidden pages in search
|
|
247
|
+
|
|
248
|
+
**Requires dashboard setup (human task):**
|
|
249
|
+
- Custom domains and subdomains
|
|
250
|
+
- Preview deployment settings
|
|
251
|
+
- DNS configuration
|
|
252
|
+
|
|
253
|
+
For `/docs` subpath hosting with Vercel or Cloudflare, agents can help configure rewrite rules. See [/docs subpath](https://mintlify.com/docs/deploy/vercel).
|
|
254
|
+
|
|
255
|
+
## Workflow
|
|
256
|
+
|
|
257
|
+
### 1. Understand the task
|
|
258
|
+
|
|
259
|
+
Identify what needs to be documented, which pages are affected, and what the reader should accomplish afterward. If any of these are unclear, ask.
|
|
260
|
+
|
|
261
|
+
### 2. Research
|
|
262
|
+
|
|
263
|
+
- Read `docs.json` to understand the site structure
|
|
264
|
+
- Search existing docs for related content
|
|
265
|
+
- Read similar pages to match the site's style
|
|
266
|
+
|
|
267
|
+
### 3. Plan
|
|
268
|
+
|
|
269
|
+
- Synthesize what the reader should accomplish after reading the docs and the current content
|
|
270
|
+
- Propose any updates or new content
|
|
271
|
+
- Verify that your proposed changes will help readers be successful
|
|
272
|
+
|
|
273
|
+
### 4. Write
|
|
274
|
+
|
|
275
|
+
- Start with the most important information
|
|
276
|
+
- Keep sections focused and scannable
|
|
277
|
+
- Use components appropriately (don't overuse them)
|
|
278
|
+
- Mark anything uncertain with a TODO comment:
|
|
279
|
+
|
|
280
|
+
```mdx
|
|
281
|
+
{/* TODO: Verify the default timeout value */}
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### 5. Update navigation
|
|
285
|
+
|
|
286
|
+
If you created a new page, add it to the appropriate group in `docs.json`.
|
|
287
|
+
|
|
288
|
+
### 6. Verify
|
|
289
|
+
|
|
290
|
+
Before submitting:
|
|
291
|
+
|
|
292
|
+
- [ ] Frontmatter includes title and description
|
|
293
|
+
- [ ] All code blocks have language tags
|
|
294
|
+
- [ ] Internal links use root-relative paths without file extensions
|
|
295
|
+
- [ ] New pages are added to `docs.json` navigation
|
|
296
|
+
- [ ] Content matches the style of surrounding pages
|
|
297
|
+
- [ ] No marketing language or filler phrases
|
|
298
|
+
- [ ] TODOs are clearly marked for anything uncertain
|
|
299
|
+
- [ ] Run `mint broken-links` to check links
|
|
300
|
+
- [ ] Run `mint validate` to find any errors
|
|
301
|
+
|
|
302
|
+
## Edge cases
|
|
303
|
+
|
|
304
|
+
### Migrations
|
|
305
|
+
|
|
306
|
+
If a user asks about migrating to Mintlify, ask if they are using ReadMe or Docusaurus. If they are, use the [@mintlify/scraping](https://www.npmjs.com/package/@mintlify/scraping) CLI to migrate content. If they are using a different platform to host their documentation, help them manually convert their content to MDX pages using Mintlify components.
|
|
307
|
+
|
|
308
|
+
### Hidden pages
|
|
309
|
+
|
|
310
|
+
Any page that is not included in the `docs.json` navigation is hidden. Use hidden pages for content that should be accessible by URL or indexed for the assistant or search, but not discoverable through the sidebar navigation.
|
|
311
|
+
|
|
312
|
+
### Exclude pages
|
|
313
|
+
|
|
314
|
+
The `.mintignore` file is used to exclude files from a documentation repository from being processed.
|
|
315
|
+
|
|
316
|
+
## Common gotchas
|
|
317
|
+
|
|
318
|
+
1. **Component imports** - JSX components need explicit import, MDX components don't
|
|
319
|
+
2. **Frontmatter required** - Every MDX file needs `title` at minimum
|
|
320
|
+
3. **Code block language** - Always specify language identifier
|
|
321
|
+
4. **Never use `mint.json`** - `mint.json` is deprecated. Only ever use `docs.json`
|
|
322
|
+
|
|
323
|
+
## Resources
|
|
324
|
+
|
|
325
|
+
- [Documentation](https://mintlify.com/docs)
|
|
326
|
+
- [Configuration schema](https://mintlify.com/docs.json)
|
|
327
|
+
- [Feature requests](https://github.com/orgs/mintlify/discussions/categories/feature-requests)
|
|
328
|
+
- [Bugs and feedback](https://github.com/orgs/mintlify/discussions/categories/bugs-feedback)
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: product-launch-video
|
|
3
|
+
description: "turn a product or marketing URL, pasted script, or brief into a product launch video, including SaaS promos, feature reveals, app launches, company promos, and product marketing videos. Use this skill when the user wants to market, launch, promote, or reveal a product. Do not use it for general non-launch website tours, non-product topic explainers, GitHub pull requests, captioning existing footage, or short unnarrated motion graphics. If the intent is unclear, route through /hyperframes first. This is the new shot-sequence architecture: every visual frame is authored as a time-coded shot sequence picked from a menu of golden blueprints, so frames develop over their full duration instead of freezing after entrance."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
> **media-use**: Before sourcing audio/images, call `/media-use` to resolve BGM/SFX/images from the HeyGen catalog. Run `--adopt` first to register existing assets. See `/media-use` skill.
|
|
7
|
+
|
|
8
|
+
# Product Launch to HyperFrames
|
|
9
|
+
|
|
10
|
+
Use this skill to capture a product, understand its brand, plan a launch video, and build it frame by frame in HyperFrames.
|
|
11
|
+
|
|
12
|
+
> **Confirm the route before Step 0.** You are the orchestrator. Run each step, verify its gate, and only then continue to the next step. This skill is for a **product being marketed, launched, promoted, or revealed**, including requests such as "promo for our site" when the purpose is promotional. Route other intents elsewhere: a general non-launch website tour -> `/website-to-video`; a topic explainer with no product -> `/faceless-explainer`; a GitHub PR -> `/pr-to-video`; captions on existing footage -> `/embedded-captions`; a short unnarrated motion graphic -> `/motion-graphics`. If the user says only "make a video" or the route is uncertain, read `/hyperframes` first.
|
|
13
|
+
|
|
14
|
+
You are the orchestrator. Work in `videos/<project>/`. Run steps in order and pass each gate before continuing. User-gated steps are Step 0, Step 3, and Step 6. Do every step yourself except Step 5, where you dispatch one sub-agent per frame. Do not put design or motion rules here; those live in the frame-worker sub-agent, this skill's local `../hyperframes-animation/rules/` + `../hyperframes-animation/blueprints/`, and `hyperframes-creative`.
|
|
15
|
+
|
|
16
|
+
Workflow: Step 0 setup -> `hyperframes.json`; Step 1 capture -> `capture/`; Step 2 design system -> `frame.md`; Step 3 storyboard/script -> `STORYBOARD.md` and `SCRIPT.md`; Step 3.1 audio -> `audio_meta.json`; Step 4 visual design -> enriched `STORYBOARD.md`; Step 5 frames -> `compositions/frames/NN-*.html` and `index.html`; Step 6 final render -> `renders/video.mp4`.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Step 0: Setup and Brief
|
|
21
|
+
|
|
22
|
+
Goal: Lock the core video brief and create the HyperFrames project if needed.
|
|
23
|
+
|
|
24
|
+
Initialize only if `hyperframes.json` is missing. Name `<project>` from the brand or domain in kebab-case, such as `acme-promo`; never use workspace name or timestamp.
|
|
25
|
+
|
|
26
|
+
`npx hyperframes init "videos/<project>" --non-interactive --example=blank` — `init` checks the installed skills against the latest on GitHub and updates the global set if any are out of date.
|
|
27
|
+
|
|
28
|
+
**Show sign-in status before the brief** — run `npx hyperframes auth status` and **relay its output verbatim (don't paraphrase or rewrite it).** It reports whether voice/BGM will use HeyGen or local engines and, when not signed in, how to sign in. **If not signed in, STOP and wait for the user to choose — sign in, or say "go"/"offline" to continue with local engines — before asking the brief or anything else.** Treat it as a real decision point, not a passing note; don't fold the choice into the brief question, and don't write keys into a per-repo `.env`. (In autonomous mode, note the status and continue offline.) See `../hyperframes-media` → Preflight for the canonical guidance.
|
|
29
|
+
|
|
30
|
+
**Gate:** `hyperframes.json` exists, and angle, length, aspect ratio, and language are locked; sign-in status was shown (signed in, or continuing offline).
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## Step 1: Capture assets
|
|
35
|
+
|
|
36
|
+
Goal: Collect the source material, brand signals, and usable assets for the video.
|
|
37
|
+
|
|
38
|
+
Classify the input and choose the path. Explicit URL -> capture it and use the site for narration and assets. Pasted script/brief -> save verbatim as `user_script.txt`, ask once "use it verbatim or restructure?", store answer as `VO_MODE`, then resolve capture target: URL in text -> use it; brand name only -> `WebSearch`, confirm URL in one line, then crawl; no URL/site -> no-capture path.
|
|
39
|
+
|
|
40
|
+
Run capture with: `npx hyperframes capture "<URL>" -o ./capture`
|
|
41
|
+
|
|
42
|
+
If `GEMINI_API_KEY`, `GOOGLE_API_KEY`, or an OpenRouter key exists, capture auto-captions assets into `capture/extracted/asset-descriptions.md`. This is not a review gate. Without a vision key, use DOM context and continue.
|
|
43
|
+
|
|
44
|
+
No-capture path: create `capture/extracted/tokens.json`, `capture/extracted/visible-text.txt`, `capture/extracted/asset-descriptions.md`, and `capture/assets/` by hand. `tokens.json` should be `{ "title": "", "description": "", "colors": [], "fonts": [] }`; fill title/description from the brief when possible. `visible-text.txt` contains the full brief or script. `asset-descriptions.md` should say no assets were captured unless the user gave asset notes.
|
|
45
|
+
|
|
46
|
+
**Gate:** `capture/extracted/tokens.json`, `capture/extracted/visible-text.txt`, `capture/extracted/asset-descriptions.md`, and `capture/assets/` exist; you can state the brand in one clear sentence. Treat `asset-descriptions.md` as the main asset inventory. If it is missing after real capture, stop and report capture incomplete. If `capture/BLOCKED.md` exists, follow it.
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Step 2: Design System
|
|
51
|
+
|
|
52
|
+
Goal: Choose one shipped frame preset; a script turns it into this video's `frame.md` + caption skin.
|
|
53
|
+
|
|
54
|
+
You make the one judgment call — **which preset**. Read `../hyperframes-creative/references/design-spec.md` and pick the preset whose look best fits the brand and brief. Then run:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
node <SKILL_DIR>/scripts/build-frame.mjs --preset <name> --hyperframes .
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
The script does the rest deterministically: copies the preset's `FRAME.md` → `frame.md` and **remixes** it onto the brand tokens in `capture/extracted/tokens.json` (brand colors mapped onto the preset's color keys by role — ink, canvas, accents — keeping keys/structure/components; the preset's display + body fonts swapped for the brand's), copies the preset's caption skin to `.hyperframes/caption-skin.html`, and self-validates (exits 1 on a broken mapping). Proceed to the next step as soon as it exits 0 — no hand-editing of the spec.
|
|
61
|
+
|
|
62
|
+
`tokens.json` with no brand colors/fonts (e.g. no capture) → the script keeps the preset's own palette, a complete shippable design. If the brief names brand colors/fonts the capture missed, add them to `capture/extracted/tokens.json` before running (or use the user's `design.md` to populate it); only adjust `frame.md` by hand afterward if a mapping truly needs it.
|
|
63
|
+
|
|
64
|
+
**Gate:** `build-frame.mjs` exited 0 — `frame.md` exists from a named preset, and (when the preset ships one) `.hyperframes/caption-skin.html` exists as the caption skin source.
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Step 3: Storyboard and Script
|
|
69
|
+
|
|
70
|
+
Goal: Turn the brief and captured material into an approved frame-by-frame story plan.
|
|
71
|
+
|
|
72
|
+
Read `references/story-design.md`, `../hyperframes-animation/blueprints-index.md`, `../hyperframes-core/references/storyboard-format.md`, and `../hyperframes-core/references/script-format.md`. Use them to write `STORYBOARD.md` and, when narration is needed, `SCRIPT.md`.
|
|
73
|
+
|
|
74
|
+
Use `story-design.md` for story blueprint, hook, persuasion logic, beats, `VO_MODE`, and asset choices. As a **soft guide**, consult the role→blueprint menu in `../hyperframes-animation/blueprints-index.md`: for each beat, note a candidate blueprint id when one fits. Story truth still decides which beats exist — never force a beat to fit a blueprint, and never invent a beat just because a proven shape is available. Choose each visual frame's `asset_candidates` from `capture/extracted/asset-descriptions.md` (the canonical inventory) — don't browse raw `capture/assets/`. Do not ask the user to pick assets unless that inventory is missing or unusable. Use the exact required fields from the storyboard and script references.
|
|
75
|
+
|
|
76
|
+
After drafting, show a frame-by-frame summary. In that same message ask the user two things: (a) to approve or request changes, and (b) whether they want a live preview of the storyboard scaffold (npx hyperframes preview) — open it only on a yes. Iterate until approved, and carry the preview choice to Step 6.
|
|
77
|
+
|
|
78
|
+
**Gate:** `STORYBOARD.md` exists, every visual frame has `asset_candidates`, `SCRIPT.md` exists when narration is needed, and the user approved the frame-by-frame plan.
|
|
79
|
+
|
|
80
|
+
---
|
|
81
|
+
|
|
82
|
+
## Step 3.1: Audio
|
|
83
|
+
|
|
84
|
+
Goal: Generate narration, word timings, music, and audio metadata from the approved script.
|
|
85
|
+
|
|
86
|
+
Start audio after Step 3 approval. Run it in the background, then continue to Step 4.
|
|
87
|
+
|
|
88
|
+
`node <SKILL_DIR>/scripts/audio.mjs --script ./SCRIPT.md --storyboard ./STORYBOARD.md --hyperframes . --out ./audio_meta.json &`
|
|
89
|
+
|
|
90
|
+
The audio script handles narration, word timings, BGM lookup from HeyGen's music library, and timing metadata. BGM mood comes from the storyboard's `music:` field. This uses the HeyGen Audio API for retrieval, not generation, and uses the same `~/.heygen` credential as TTS. For provider details, read `../hyperframes-media/references/tts.md`.
|
|
91
|
+
|
|
92
|
+
If there is no narration and no `SCRIPT.md`, skip voice generation. BGM may still run if the storyboard has a music mood.
|
|
93
|
+
|
|
94
|
+
**Gate:** audio job has started, or the project is marked silent.
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Step 4: Frame Visual Design
|
|
99
|
+
|
|
100
|
+
Goal: Add the visual direction, layout intent, and motion choices to each storyboard frame.
|
|
101
|
+
|
|
102
|
+
Edit `STORYBOARD.md` in place. Do not create another storyboard. Use `frame.md` as source of truth for color, type, layout feel, and style.
|
|
103
|
+
|
|
104
|
+
Read `references/visual-design.md`, `../hyperframes-animation/blueprints-index.md`, `references/motion-language.md`, and `../hyperframes-animation/rules-index.md`. Use `visual-design.md` for the method (the time-coded shot sequence, the inline Layout vocabulary, and the required `## Video direction` block). Use `../hyperframes-animation/blueprints-index.md` to pick each frame's shot shape. Use `motion-language.md` (the motion vocabulary + the motion doctrine) and `../hyperframes-animation/rules-index.md` (valid rule names) for motion — do not invent motion names.
|
|
105
|
+
|
|
106
|
+
For every visual frame, write a **time-coded shot sequence** into `STORYBOARD.md` per `visual-design.md`'s method: pick the frame's blueprint (or compose), instantiate it with THIS product's content, and pace each Scene's reveal to the voiceover so the frame develops across its full duration instead of front-loading then freezing. State layout and motion **inline** per Scene (vocabularies in `visual-design.md` and `motion-language.md`). Add one video-wide `## Video direction` block.
|
|
107
|
+
|
|
108
|
+
Do not change story, script, asset choices, `asset_candidates`, `transition_in`, or captured source material. Do not write HTML in this step.
|
|
109
|
+
|
|
110
|
+
Stage named assets after visual design is locked:
|
|
111
|
+
|
|
112
|
+
`node <SKILL_DIR>/scripts/stage-assets.mjs --storyboard ./STORYBOARD.md --hyperframes .`
|
|
113
|
+
|
|
114
|
+
**Gate:** every visual frame has a time-coded shot sequence whose reveals are paced to the voiceover (no front-loading); `## Video direction` exists; `assets/` contains the named assets.
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Step 5: Build Frames
|
|
119
|
+
|
|
120
|
+
Goal: Build every storyboard frame as an HTML composition and assemble the playable video.
|
|
121
|
+
|
|
122
|
+
Wait for Step 3.1 audio to finish if audio was started. Then sync durations and fetch SFX; skip both if silent.
|
|
123
|
+
|
|
124
|
+
`node <SKILL_DIR>/scripts/audio.mjs sync-durations --audio-meta ./audio_meta.json --storyboard ./STORYBOARD.md`
|
|
125
|
+
|
|
126
|
+
`node <SKILL_DIR>/scripts/audio.mjs fetch-sfx --storyboard ./STORYBOARD.md --hyperframes .`
|
|
127
|
+
|
|
128
|
+
Duration sync is mechanical: real voice duration wins; silent frames keep estimates; never hand-edit synced durations.
|
|
129
|
+
|
|
130
|
+
Before dispatch, read `sub-agents/frame-worker.md` and `../hyperframes-core/references/subagent-dispatch.md`. Dispatch one sub-agent per frame, in parallel if possible; otherwise run workers in waves. Each worker gets exactly one frame.
|
|
131
|
+
|
|
132
|
+
Each worker context must include `PROJECT_DIR`, `frame_id`, canvas size, caption status and keep-out band if captions are enabled, and `RULES_DIR` as the absolute path to this skill's `../hyperframes-animation/rules/`. Each worker reads `frame.md`, its own `## Frame N` block from `STORYBOARD.md`, the local rule recipe (`../hyperframes-animation/rules/<id>.md`) for each cited motion, and the frame's blueprint template (`../hyperframes-animation/blueprints/<id>.md`). Each worker writes only `compositions/frames/NN-*.html`. Workers must never edit `STORYBOARD.md`.
|
|
133
|
+
|
|
134
|
+
As each worker returns, the orchestrator marks that frame as `animated` in `STORYBOARD.md`.
|
|
135
|
+
|
|
136
|
+
After audio timings exist, build captions in the background and assemble the index:
|
|
137
|
+
|
|
138
|
+
`node <SKILL_DIR>/scripts/captions.mjs build --storyboard ./STORYBOARD.md --audio-meta ./audio_meta.json --hyperframes . --out ./caption_groups.json &`
|
|
139
|
+
|
|
140
|
+
`node <SKILL_DIR>/scripts/assemble-index.mjs --storyboard ./STORYBOARD.md --hyperframes .`
|
|
141
|
+
|
|
142
|
+
`captions.mjs` uses the project's `.hyperframes/caption-skin.html` (copied in Step 2) as the caption look, injecting brand tokens from `frame.md`; with no skin present it renders the built-in default pill. `captions: skipped (<reason>)` is valid. Continue without captions when explicitly skipped.
|
|
143
|
+
|
|
144
|
+
**Gate:** every frame is marked `animated`, `index.html` exists, and captions are built or explicitly skipped.
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Step 6: Finalize
|
|
149
|
+
|
|
150
|
+
Goal: Verify the assembled video, get user approval, and render the final MP4.
|
|
151
|
+
|
|
152
|
+
Inject transitions, run checks, pause for review, then render.
|
|
153
|
+
|
|
154
|
+
`node <SKILL_DIR>/scripts/transitions.mjs inject --storyboard ./STORYBOARD.md --hyperframes .`
|
|
155
|
+
|
|
156
|
+
`node <SKILL_DIR>/scripts/transitions.mjs verify --storyboard ./STORYBOARD.md --index ./index.html`
|
|
157
|
+
|
|
158
|
+
`npx hyperframes lint`
|
|
159
|
+
|
|
160
|
+
`npx hyperframes validate`
|
|
161
|
+
|
|
162
|
+
`npx hyperframes inspect`
|
|
163
|
+
|
|
164
|
+
`npx hyperframes snapshot --at <frame-midpoints>`
|
|
165
|
+
|
|
166
|
+
`snapshot` stitches the captured frames into one contact sheet (`snapshots/contact-sheet.jpg`). Glance at it; if nothing is obviously broken, move on — don't linger here.
|
|
167
|
+
|
|
168
|
+
If a command fails, surface stderr and stop — don't pile on recovery commands. Fix it yourself: the cheapest safe edit to `compositions/frames/NN-*.html`, then rerun the failed check.
|
|
169
|
+
|
|
170
|
+
After checks pass, pause for user review. The video is assembled, viewable, and editable in Studio. Manage preview only once across Step 3 and Step 6: open it if the user asked earlier, offer it if they declined earlier, and do not ask again if they are already reviewing in Studio.
|
|
171
|
+
|
|
172
|
+
Preview: `npx hyperframes preview`
|
|
173
|
+
|
|
174
|
+
Render only after user approval:
|
|
175
|
+
|
|
176
|
+
`npx hyperframes render --skill=product-launch-video --quality high --output renders/video.mp4`
|
|
177
|
+
|
|
178
|
+
Do not rerun `lint`, `validate`, `inspect`, or `snapshot` after rendering unless the user asks.
|
|
179
|
+
|
|
180
|
+
**Gate:** `lint`, `validate`, and `inspect` passed before render; user approved at the review pause; `renders/video.mp4` exists. Final reply states MP4 path and final duration.
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## Quick Reference
|
|
185
|
+
|
|
186
|
+
**Formats:** landscape `1920x1080` by default; portrait `1080x1920`; square `1080x1080`. Set the format once in the storyboard frontmatter.
|
|
187
|
+
|
|
188
|
+
**Background scripts:** the workflow ships only these scripts under `scripts/`: `build-frame` for adopting + brand-remixing a frame preset into `frame.md` (+ caption skin); `audio` for TTS, transcription, BGM, SFX, and duration syncing; `captions`; `transitions` for inject and verify; `stage-assets` for copying frame-named assets into `assets/`; and `assemble-index`. Everything else is handled by the `hyperframes` CLI.
|
|
189
|
+
|
|
190
|
+
The reusable, product-agnostic shot shapes live in `../hyperframes-animation/blueprints/` (indexed by `../hyperframes-animation/blueprints-index.md`).
|
|
191
|
+
|
|
192
|
+
| Read | When |
|
|
193
|
+
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
|
194
|
+
| `[../hyperframes-creative/frame-presets/](../hyperframes-creative/frame-presets/)` | Step 2: choose and adopt a frame preset. |
|
|
195
|
+
| `[../hyperframes-creative/references/design-spec.md](../hyperframes-creative/references/design-spec.md)` | Step 2: apply brand tokens correctly. |
|
|
196
|
+
| `[references/story-design.md](references/story-design.md)` | Step 3: plan the product-launch story. |
|
|
197
|
+
| `[../hyperframes-animation/blueprints-index.md](../hyperframes-animation/blueprints-index.md)` | Step 3: role→blueprint menu. Step 4: pick the shot shape. |
|
|
198
|
+
| `[../hyperframes-core/references/storyboard-format.md](../hyperframes-core/references/storyboard-format.md)` | Step 3: write `STORYBOARD.md`. |
|
|
199
|
+
| `[../hyperframes-core/references/script-format.md](../hyperframes-core/references/script-format.md)` | Step 3: write `SCRIPT.md`. |
|
|
200
|
+
| `[../hyperframes-media/references/tts.md](../hyperframes-media/references/tts.md)` | Step 3.1: choose or understand TTS providers and voices. |
|
|
201
|
+
| `[references/visual-design.md](references/visual-design.md)` | Step 4: write the frame's shot sequence (+ Layout vocabulary). |
|
|
202
|
+
| `[references/motion-language.md](references/motion-language.md)` | Step 4: the motion vocabulary + the motion doctrine. |
|
|
203
|
+
| `[references/cut-catalog.md](references/cut-catalog.md)` | Step 4-5: the cut catalog (worker builds within-frame seams). |
|
|
204
|
+
| `[../hyperframes-animation/rules-index.md](../hyperframes-animation/rules-index.md)` + `[../hyperframes-animation/rules/](../hyperframes-animation/rules/)` | Step 5: local rule recipe bodies for the cited motions. |
|
|
205
|
+
| `[sub-agents/frame-worker.md](sub-agents/frame-worker.md)` | Step 5: dispatch per-frame workers. |
|
|
206
|
+
| `[../hyperframes-core/references/subagent-dispatch.md](../hyperframes-core/references/subagent-dispatch.md)` | Step 5: dispatch sub-agents safely. |
|