docs(studio): describe the dock layout and point comments at the renamed right panels

This commit is contained in:
Miguel Angel Simon Sierra
2026-09-19 17:35:08 -04:00
parent d74b599cc7
commit b6c63b6ea0
6 changed files with 10 additions and 8 deletions
+1 -1
View File
@@ -226,7 +226,7 @@
// collision.
{ "file": "packages/cli/src/commands/*.ts", "exports": ["examples"] },
// Options type for the render-queue hook's public startRender callback —
// consumed structurally by callers (StudioRightPanel), not by import.
// consumed structurally by callers (StudioRightPanels), not by import.
{
"file": "packages/studio/src/components/renders/useRenderQueue.ts",
"exports": ["StartRenderOptions"],
+4 -2
View File
@@ -32,8 +32,10 @@ npx hyperframes preview
- **Preview** shows the built project. The live frame is in the middle, the
timeline is below, project tools are on the left, and the Inspector is on the
right.
- **Code**, **Comps**, **Assets**, and **Catalog** expose the project source,
right. Drag any panel tab to move it, and use **Window** in the header to
reopen a closed panel or reset the layout. Studio remembers your layout for
each project.
- **Code**, **Compositions**, **Assets**, and **Catalog** expose the project source,
compositions, media, and reusable visuals. **Design**, **Layers**,
**Variables**, and **Renders** control the selected work.
+2 -2
View File
@@ -23,7 +23,7 @@ the surfaces without exporting or converting the project.
## Make a focused source edit
1. Open **Code** in the left sidebar.
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.
@@ -68,7 +68,7 @@ must remain true.
## Run Studio Lint
Choose **Lint** at the bottom of the left sidebar. Studio opens **HyperFrame
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.
@@ -156,7 +156,7 @@ export function makeSlideshowNotesController(): NotesController {
// ── Component ─────────────────────────────────────────────────────────────
export interface SlideshowPanelProps {
/** Scenes from the live clip manifest (passed from StudioRightPanel). */
/** Scenes from the live clip manifest (passed from StudioRightPanels). */
scenes: import("./slideshowPanelHelpers").SceneInfo[];
/**
* Called with the updated manifest after every discrete edit (toggle, add,
@@ -246,7 +246,7 @@ const EMPTY_STATE = (
</p>
);
// Panel orchestrator — JSX conditionals per section, same shape as StudioRightPanel.
// Panel orchestrator — JSX conditionals per section, same shape as StudioRightPanels.
// fallow-ignore-next-line complexity
export const VariablesPanel = memo(function VariablesPanel({
sdkSession,
@@ -7,7 +7,7 @@ import { usePreviewVariablesStore } from "../../hooks/previewVariablesStore";
/**
* The Renders tab, wired to the shell context.
*
* Split out of StudioRightPanel because every field it needs already lives in
* Split out of StudioRightPanels because every field it needs already lives in
* that context, so routing them through the panel only made the panel longer
* without giving anything a second reader.
*/