mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-10-30 17:27:09 +00:00
* feat(studio): every Studio panel is a dock panel and the shell moves onto it
EditorShell, App.tsx, the left and right panel columns, and the
inspector hooks now render through Dock.Panel instead of the old
fixed-width sidebars and split-pane inspector. usePanelLayout becomes
a thin facade over the dock store; fitPanels, the resize divider and
the split-inspector hook are dead and removed.
* refactor(studio): drop dead inspector flags and stale fallow entries after dock migration
Collapse inspectorButtonActive into inspectorPanelActive, remove unread
layers/design active fields, un-export unused prop types, flatten a nested
ternary, and point fallow ignores at the renamed/deleted files.
* fix(studio): keep right-panel behaviours the dock migration dropped
Block params dismiss on selection or when Design is hidden, the slideshow
panel can be closed, the selection outline follows the inspector intent,
caption editing focuses Design, and a URL slideshow tab opens once the
panel exists.
* refactor(studio): name the inspector-open state once in the header
* fix(studio): right-panel behaviours survive selection, restore and reopen after the dock migration
Block params stay open over an element that was already selected, caption mode wins over block params, the slideshow panel waits for the dock, the Renders tab title survives a reopen, each side column remembers the tab it last showed, tab switches are reported only when the tab changes, and the e2e thumbnail selector follows the dock.
* docs(studio): describe the dock layout and point comments at the renamed right panels
* fix(studio): block params survive a preview reload of the selected element, and panel titles are covered
The dismissal compares the selected element by its target key instead of object identity, because a preview reload rebuilds the selection for the same element. A closed and reopened panel keeps its custom title, with a test, and the e2e selector is formatted.
* fix(studio): block params leave with any other tab pick, and a restored slideshow placement survives loading
Block params are now dismissed by the tab setter the way their old tab was, including a re-pick of the same element, instead of by comparing selections. The slideshow panel is only closed after a file that was a slideshow stops being one, so a restored layout is not discarded while the file loads.
* refactor(studio): drop the duplicate inspector-open computation
The rebase onto main left two identical inspectorButtonActive/inspectorOpen
constants after a conflict resolution; only the first was still referenced.
* chore(studio): allow the dock migration deletions in the guard
StudioLeftSidebar.tsx, LeftSidebar.tsx and its storage test,
TimelineResizeDivider.tsx, useInspectorSplitResize.ts and fitPanels
are replaced by the dock; the CI deletion guard needs each named
with its reason.
* style(studio): oxfmt the deletion-guard entries
* fix(studio): rename Timeline's aria-label so it does not collide with its dock panel wrapper
Every dock panel wrapper now carries aria-label=<title>, matching the "Timeline"
title for the timeline panel. Timeline.tsx also set aria-label="Timeline" on its
own content div, so `document.querySelector('[aria-label=\"Timeline\"]')` found
the dock wrapper first and the timeline viewport gate CI check timed out waiting
for an attribute the real content div actually carried. Renamed to "Timeline
track view" and updated every consumer: the production diagnostics selector,
its tests, and the e2e viewport-gate script.
* fix(studio): restore inspectorButtonActive as a real prop after a rebase regression
Rebasing PR2 onto main replayed an older local commit whose diff did not
textually overlap main's newer inspectorButtonActive prop, so git applied
it with no conflict marker and silently reverted the header to computing
the value itself instead of receiving it. StudioHeader.dom.test.tsx already
asserts the prop is respected; restoring it makes that test meaningful
again. App.tsx now computes it once (panelLayout.rightCollapsed is already
the dock's effective collapse state, no separate railed-by-width case) and
passes it down.
* chore(studio): wrap a long doc comment in useRightPanelIntents
122 lines
5.1 KiB
Plaintext
122 lines
5.1 KiB
Plaintext
---
|
|
title: "Work with source and an agent"
|
|
sidebarTitle: "Source and agent"
|
|
description: "Edit project files, diagnose a failed check, and hand the right context to an AI agent."
|
|
---
|
|
|
|
Studio, your agent, and the CLI work on the same project files. Use **Code** for
|
|
a small source change you understand. Use the agent when the change crosses
|
|
files, affects project structure, or starts from an unfamiliar failure.
|
|
|
|
## Choose the smallest safe surface
|
|
|
|
| Change | Best starting point |
|
|
| ---------------------------------------------------------------- | ------------------------------ |
|
|
| Visible text, layout, style, media, timing, or supported motion | Canvas, Inspector, or timeline |
|
|
| One known value in one known file | Code |
|
|
| Story, several scenes, generated animation, or project structure | Agent |
|
|
| A reported lint problem with a clear direct fix | Studio or Code |
|
|
| An unfamiliar failure or a fix spanning files | Copy to Agent |
|
|
|
|
The choice is about the change, not a permanent workflow. You can move between
|
|
the surfaces without exporting or converting the project.
|
|
|
|
## Make a focused source edit
|
|
|
|
1. Open **Code** in the left panel column.
|
|
2. Select the exact file in the project tree.
|
|
3. Find the value responsible for the visible result.
|
|
4. Make one focused change.
|
|
5. Wait for the preview to refresh, then play the affected moment.
|
|
|
|
The Code editor saves user edits automatically and records them in Studio
|
|
history. If a save fails, Studio says that the latest edit was not persisted;
|
|
fix the preview-server or connection problem before continuing.
|
|
|
|
<Warning>
|
|
Creating, renaming, moving, or deleting a file can break references elsewhere in the project.
|
|
Search for the old path or ask the agent to update every reference.
|
|
</Warning>
|
|
|
|
Avoid editing the same file in Studio and another tool at the same time. If an
|
|
external change lands first, the Code editor rejects the conflicting save and
|
|
tells you that the latest edit was not persisted. Reload the current file,
|
|
review the external change, then apply your edit again. The separate queue for
|
|
visual canvas edits can pause and show a banner while a conflict is resolved.
|
|
|
|
## Ask about the selected element
|
|
|
|
When a visible element needs source work, select it and choose **Ask agent about
|
|
this element**. Studio prepares the element and project context, combines it
|
|
with your instruction, and copies the prompt to the clipboard. Paste that
|
|
prompt into your agent chat.
|
|
|
|
<Frame caption="Studio prepares a prompt for the selected element; you paste it into your agent chat.">
|
|
<img
|
|
src="https://static.heygen.ai/hyperframes-oss/docs/images/studio/ask-agent-v1.jpg"
|
|
alt="HyperFrames Studio dialog for copying a prompt about the selected element and project context"
|
|
/>
|
|
</Frame>
|
|
|
|
```text
|
|
Keep the current narration and scene order. Make this product panel readable
|
|
at the final video size, and do not change the following scene.
|
|
```
|
|
|
|
The copied context tells the agent where to look. Your sentence tells it what
|
|
must remain true.
|
|
|
|
## Run Studio Lint
|
|
|
|
Choose **Lint** at the bottom of the left panel column. Studio opens **HyperFrame
|
|
Lint Results** with errors, warnings, file locations, and fix hints when they
|
|
are available.
|
|
|
|
Fix a simple, understood issue directly, then run Lint again. Use **Copy to
|
|
Agent** when the source location is unfamiliar or the fix may affect other
|
|
files. Add what happened before the error and what you expected:
|
|
|
|
```text
|
|
This appeared after I shortened the intro clip. I expected the title animation
|
|
to keep its current timing. Fix the issue without changing the rest of the
|
|
opening.
|
|
```
|
|
|
|
Do not paste only the error message when the intended result matters. A
|
|
technically valid repair can still make the wrong creative change.
|
|
|
|
## Use the project-level gates before delivery
|
|
|
|
Studio Lint is a quick in-editor pass. The project-level commands remain the
|
|
final gate, especially when the project contains nested compositions:
|
|
|
|
```bash
|
|
npx hyperframes lint
|
|
npx hyperframes check
|
|
```
|
|
|
|
`lint` checks the composition structure. `check` adds browser, runtime, layout,
|
|
motion, and WCAG contrast verification.
|
|
|
|
Passing checks do not approve the story or the final encode. Play the project
|
|
after a source fix, then watch the rendered file before sharing it.
|
|
|
|
## When the preview and source disagree
|
|
|
|
1. Stop editing until the latest save finishes.
|
|
2. Keep the first exact error or save warning.
|
|
3. Reload the project only after checking whether another tool changed the file.
|
|
4. Run the project checks.
|
|
5. Ask the agent with the error, project path, action that caused it, and result
|
|
you expected.
|
|
|
|
Use [Studio troubleshooting](/studio/troubleshooting) for editor, preview, and
|
|
render-queue failures. Use [Finish and share](/guides/export-and-share) for the
|
|
complete approval, validation, render, and delivery path.
|
|
|
|
## Related topics
|
|
|
|
- [Recover from a Studio problem](/studio/troubleshooting)
|
|
- [Understand a HyperFrames project](/concepts)
|
|
- [Finish, render, and share](/guides/export-and-share)
|