docs: add Mintlify documentation site - #33
Merged
Conversation
Set up /docs directory with docs.json config, HeyGen branding (logo, favicon, #7559FF purple), and 18 MDX pages covering: - Getting started (introduction, quickstart) - Concepts (compositions, data attributes, frame adapters, determinism) - Guides (GSAP animation, templates, rendering, common mistakes, troubleshooting) - Package docs (core, engine, producer, studio, CLI) - Reference (HTML schema) and contributing guide Content adapted from existing repo docs (core/docs/, cli/src/docs/, README). Validated with `mint validate` and `mint broken-links`. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Major improvements across all 18 pages: - Use Mintlify components: <Steps> for tutorials, <Tabs> for alternatives, <CodeGroup> for multi-platform commands, <Tree> for directory structures, <AccordionGroup> for FAQ/scannable content, <Mermaid> for diagrams - Add filename annotations to all code blocks (e.g., ```html index.html) - Add numbered comments inside multi-step code examples - Show expected terminal output after CLI commands - Add "When to use" / "When NOT to use" sections to all package pages - Add "Next Steps" CardGroup to every page (no dead-end pages) - Cross-link between pages at point of curiosity (not just "see also" dumps) - Expand thin pages (engine, studio) with architecture details and examples - Add decision guides (rendering modes, template selection) - Use <Warning> and <Note> sparingly (max 2-3 per page) Also adds DOCS_GUIDELINES.md at repo root with writing standards. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace old gradient pinwheel logo with the current HeyGen branding: - Logo light: flat wordmark with #7559FF purple play icon (black text) - Logo dark: same wordmark with white text - Favicon: purple rounded square with white play icon (SVG) Remove old favicon.ico and gradient icon.svg. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- New docs.yml: runs `mint validate` and `mint broken-links` on docs/** changes - ci.yml: paths-ignore docs/**, *.md so build/typecheck/tests don't run on docs-only PRs - regression.yml: same paths-ignore to skip Docker regression tests on docs-only PRs No branch protection is configured, so paths-ignore won't block merges. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The repo has a ruleset requiring these checks: Build, Typecheck, Test: core, Test: engine, Test: runtime contract, regression. With paths-ignore, docs-only PRs would never report these checks, blocking merge forever. Fix: add a `changes` job using dorny/paths-filter that detects whether code files changed. Each job uses `if: needs.changes.outputs.code == 'true'` which causes GitHub to report the job as "skipped" (counts as passing) rather than "never started" (counts as pending). The regression summary job explicitly handles the no-code-changes case by checking the filter output before evaluating shard results. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace pre-Prism logos with the current Prism brand assets: - Logo light: HeyGen_Logo_Prism_Black.svg (gradient wordmark for light bg) - Logo dark: HeyGen_Logo_Prism_White.svg (gradient wordmark for dark bg) - Favicon: PRISM_ORB.svg (the new Prism orb icon) - Brand color: #00C4FF (Prism cyan) replacing #7559FF (old purple) - Update Mermaid diagram colors in determinism.mdx to match Also includes CI fix: switch from paths-ignore to dorny/paths-filter with `if:` conditions so required checks auto-pass on docs-only PRs instead of hanging as "pending". Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The CI and regression path filters included their own workflow files, which meant any PR that changed CI config would trigger the full build/test/regression suite. Workflow file changes don't need code validation — they need a test run of the workflow itself, which happens automatically. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
miguel-heygen
approved these changes
Mar 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a complete Mintlify documentation site at
/docswith 18 MDX pages, HeyGen branding, anddocs.jsonconfiguration.Why
Mintlify is configured to deploy from
heygen-com/hyperframesbranchmainat path/docs, but no docs directory exists yet. This provides the initial documentation site with content adapted from existing repo docs.How
docs.jsonwith HeyGen brand colors (#7559FF purple), logos (copied from pacific/movio), and navigation structure (3 tabs: Documentation, Packages, Reference)packages/cli/src/docs/*.md→ guides and concept pagespackages/core/docs/core.md→ HTML schema referenceREADME.md→ introduction and quickstartCONTRIBUTING.md→ contributing pagePages (18 total)
Test plan
mint validate— build validation passedmint broken-links— no broken links foundmain