docs: rebuild journeys, guides, and Studio - #2973
Closed
ukimsanov wants to merge 1 commit into
Closed
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
Pull request overview
This PR rebuilds the HyperFrames documentation information architecture around clearer user journeys, task-complete guides, and a fuller Studio manual, while adding a single “Reference Project” that can be reused across multiple docs sections.
Changes:
- Adds a new docs Reference Project under
examples/docs-reference-project/(including LFS-managed audio assets) intended to be referenced across multiple guides. - Introduces new docs UX components/snippets (workflow chooser, live reference project embed, consistent docs video player usage) and new/rewritten journey pages.
- Updates repo-level ignore/LFS configuration to support shipping the new example project without committing build artifacts.
Reviewed changes
Copilot reviewed 104 out of 106 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/docs/bundle-live-reference.mjs | Adds a bundling script to emit a single-file HTML version of the live Reference Project for docs embedding. |
| README.md | Adjusts skills installation wording (removes hardcoded “19” phrasing and clarifies “full set”). |
| examples/docs-reference-project/transcript.json | Adds committed word-timing transcript data for the Reference Project narration. |
| examples/docs-reference-project/STORYBOARD.md | Adds storyboard/direction for the Reference Project video. |
| examples/docs-reference-project/SCRIPT.md | Adds narration script, voice metadata, and regeneration instructions. |
| examples/docs-reference-project/README.md | Documents how to run/check/render the Reference Project and explains its structure/variables/audio/captions. |
| examples/docs-reference-project/package.json | Adds pinned CLI scripts for reproducible preview/check/render/publish. |
| examples/docs-reference-project/meta.json | Adds project metadata (id/name/timestamp). |
| examples/docs-reference-project/hyperframes.json | Adds project configuration (paths, media proxying, authoring skill). |
| examples/docs-reference-project/frame.md | Adds design system/palette/type/motion/caption skin reference for the project. |
| examples/docs-reference-project/BRIEF.md | Adds the confirmed brief/intent and asset provenance. |
| examples/docs-reference-project/assets/sfx-whoosh.mp3 | Adds SFX asset via Git LFS pointer. |
| examples/docs-reference-project/assets/sfx-tick.mp3 | Adds SFX asset via Git LFS pointer. |
| examples/docs-reference-project/assets/narration.wav | Adds narration asset via Git LFS pointer. |
| examples/docs-reference-project/assets/bgm.wav | Adds BGM asset via Git LFS pointer. |
| examples/docs-reference-project/.gitignore | Ignores local working/output directories for the example project. |
| docs/workflows.mdx | Adds a “Choose a workflow” page using the new workflow chooser snippet. |
| docs/weekly-updates.mdx | Switches embedded videos to the DocsVideo component for consistency/accessibility. |
| docs/thirty-days.mdx | Adds a collected “30 Days of HyperFrames” index page with day links and “Coming next” for Day 30. |
| docs/studio/variables.mdx | Adds Studio docs page for variables/templates workflow. |
| docs/studio/troubleshooting.mdx | Adds Studio troubleshooting page. |
| docs/studio/timeline.mdx | Adds Studio timeline editing guide. |
| docs/studio/storyboard.mdx | Adds Studio storyboard review guide. |
| docs/studio/source.mdx | Adds Studio source/agent collaboration guide. |
| docs/studio/slideshows.mdx | Adds Studio slideshow authoring guide. |
| docs/studio/shortcuts.mdx | Adds Studio keyboard shortcuts reference. |
| docs/studio/index.mdx | Rebuilds the Studio overview page with embedded demo loops and updated structure. |
| docs/studio/export.mdx | Adds Studio export/renders management guide. |
| docs/studio/captions.mdx | Adds Studio caption editing guide and persistence limitations. |
| docs/studio/canvas.mdx | Adds Studio “Edit the frame” workflow guide. |
| docs/studio/assets-and-blocks.mdx | Adds Studio Assets/Catalog usage guide. |
| docs/studio/animation.mdx | Adds Studio animation/keyframes workflow guide. |
| docs/snippets/workflow-chooser.jsx | Adds the workflow chooser UI snippet used by /workflows. |
| docs/snippets/quickstart-continuation-grid.jsx | Adds a “what next” grid snippet for quickstart continuation. |
| docs/snippets/live-reference-project.jsx | Adds an interactive embed that loads a live HyperFrames composition and posts variable changes to it. |
| docs/snippets/agent-action.jsx | Adds a snippet for copy-to-clipboard agent requests. |
| docs/snippets/advanced-path-grid.jsx | Adds a “go further” next-steps grid snippet. |
| docs/reference/color-grading.mdx | Adds implementation-level reference documentation for color grading. |
| docs/product-updates.mdx | Adds a curated “Product updates” page summarizing changes in human terms. |
| docs/launch-videos.mdx | Removes the old “Launch Videos” page content. |
| docs/introduction.mdx | Rebuilds the introduction page into a journey-style “What is HyperFrames?” with showcase wall + live reference project. |
| docs/help.mdx | Adds a “Get unstuck” page with symptom-based troubleshooting routing. |
| docs/guides/voice-and-audio.mdx | Adds/rewrites voice/music/sfx/captions guidance and uses DocsVideo for examples. |
| docs/guides/timeline-editing.mdx | Removes the old timeline editing guide page content. |
| docs/guides/slideshow.mdx | Adds a workflow guide for creating interactive presentations. |
| docs/guides/product-launch-video.mdx | Adds a workflow guide for product/website videos. |
| docs/guides/pr-to-video.mdx | Adds a workflow guide for PR-to-video. |
| docs/guides/performance.mdx | Rewrites performance guidance into symptom-first troubleshooting and updated CLI examples. |
| docs/guides/open-design-hyperframes.md | Small wording update around hyperframes add registry language. |
| docs/guides/music-to-video.mdx | Adds a workflow guide for music-driven videos. |
| docs/guides/motion-graphics.mdx | Adds a workflow guide for motion-graphics videos. |
| docs/guides/media.mdx | Adds an overview guide for working with media in projects. |
| docs/guides/media-overlays.mdx | Removes the old media overlays guide page content. |
| docs/guides/keyframes.mdx | Removes the old keyframes/arc motion guide page content. |
| docs/guides/general-video.mdx | Adds a workflow guide for “General / custom video”. |
| docs/guides/figma.mdx | Rewrites/updates Figma integration guidance and terminology. |
| docs/guides/faceless-explainer.mdx | Adds a workflow guide for faceless explainers. |
| docs/guides/export-and-share.mdx | Adds a “finish and share” guide defining review + check + render workflow. |
| docs/guides/design-tools.mdx | Adds a guide for bringing in design tool artifacts (Figma/Claude/Open Design) into a project. |
| docs/guides/copilot-cli.mdx | Removes the GitHub Copilot CLI-specific guide page content. |
| docs/guides/claude-design.mdx | Removes the Claude Design guide page content. |
| docs/guides/claude-design-hyperframes.md | Updates CLI wording and refreshes reference links to moved skill docs. |
| docs/guides/choose-creation-path.mdx | Adds a guide to choose between local projects, hosted chat, design-first, and HeyGen flows. |
| docs/guides/captions-and-recuts.mdx | Adds a guide to choose between captions, overlays, and recuts for talking-head footage. |
| docs/guides/avatar-presenter.mdx | Adds a guide for incorporating avatar presenter clips into HyperFrames projects. |
| docs/guides/authentication.mdx | Rewrites authentication/provider-resolution docs and adds publishing guidance. |
| docs/guides/antigravity.mdx | Removes the Antigravity-specific guide page content. |
| docs/go-further.mdx | Adds a journey page for next steps after making a first project. |
| docs/developers/overview.mdx | Adds a developer-oriented architectural overview of composition/CLI/SDK/Player/rendering. |
| docs/developers/index.mdx | Adds the developers landing page and “smallest surface” guidance. |
| docs/developers/cli.mdx | Adds a developer CLI guide for common tasks/commands. |
| docs/deploy/overview.mdx | Adds rendering-path decision guidance (CLI vs Producer vs Engine vs cloud options). |
| docs/concepts/index.mdx | Adds a “project model” conceptual overview page. |
| docs/catalog/index.mdx | Adds a Catalog landing page and “start with the job” framing. |
| .gitignore | Whitelists the new docs reference project under examples/ while still ignoring its generated folders. |
| .gitattributes | Adds Git LFS rules for the Reference Project’s .wav/.mp3 assets. |
Suppressed comments (2)
docs/studio/index.mdx:147
altis not a valid attribute for<video>elements. Remove it; keeparia-labelif you want an explicit accessible name in addition to the Frame caption.
docs/studio/index.mdx:100altis not a valid attribute for<video>elements. Remove it (thearia-labeland Frame caption already provide accessible text).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+18
to
+20
| const html = bundledHtml | ||
| .replace("<head>", `<head>\n <base href="${baseHref}">`) | ||
| .replace(/[ \t]+$/gm, ""); |
Comment on lines
+62
to
+66
| src="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-direct-edit-loop-v2.mp4" | ||
| poster="https://static.heygen.ai/hyperframes-oss/docs/images/showcase/studio-direct-edit-loop-v2.jpg" | ||
| alt="Selecting an element and changing it in HyperFrames Studio" | ||
| aria-label="Selecting an element and changing it in HyperFrames Studio" | ||
| autoPlay |
Comment on lines
+49
to
+53
| # 1 — synthesize (ElevenLabs, via the /media-use audio engine) | ||
| node -e ' | ||
| import("'"$HOME"'/.claude/skills/media-use/audio/scripts/lib/tts.mjs").then(m => | ||
| m.synthesizeOne({ | ||
| provider: "elevenlabs", |
This was referenced Aug 3, 2026
Collaborator
Author
|
Replaced by #2977 → #2978 → #2979, which carry the same work split by shipping unit instead of by topic. This PR was 106 files and 15,659 changed lines across eight unrelated concerns — the page components, the example project, the new sections, the navigation rebuild, 24 page rewrites, and the deletions — which is not a reviewable unit for a person or an agent. The replacements, in order:
Every one of those boundaries validates at 0 dangling navigation entries and 0 broken internal links, so the site stays navigable at each step. #2974–#2976 were rebased onto #2979 unchanged in content. Also folded in while splitting:
|
This was referenced Aug 4, 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
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.
Summary
Rebuilds the public documentation around four user journeys, a task-based Guides architecture, and a complete Studio manual while preserving the approved Mintlify chrome.
Review focus
Start with
/introduction,/quickstart,/go-further,/developers,/studio,/examples, and/thirty-days.Please check whether a new reader understands the product, has one clear next move, and can reach a complete task page without navigating through a chain of routers.
Verification
Stack 1 of 4. Review this PR first.