From 22bfc3cca8779161e6ffd493544dd75b8a38a231 Mon Sep 17 00:00:00 2001 From: Vance Ingalls Date: Tue, 31 Mar 2026 00:26:00 -0700 Subject: [PATCH] fix(docs): catch remaining dev references missed in rename MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - testing-local-changes.mdx: two inline command examples - troubleshooting.mdx: anchor link #dev → #preview, "dev server" → "preview server" - cli.mdx: "dev server" → "preview server" Co-Authored-By: Claude Opus 4.6 (1M context) --- docs/contributing/testing-local-changes.mdx | 4 ++-- docs/guides/troubleshooting.mdx | 4 ++-- docs/packages/cli.mdx | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/contributing/testing-local-changes.mdx b/docs/contributing/testing-local-changes.mdx index 141ef35c1a..8c8733cfff 100644 --- a/docs/contributing/testing-local-changes.mdx +++ b/docs/contributing/testing-local-changes.mdx @@ -58,7 +58,7 @@ If you don't want to touch your global `$PATH`, add a shell alias or call `node` alias hyperframes="node /path/to/hyperframes-oss/packages/cli/dist/cli.js" # Or invoke directly -node /path/to/hyperframes-oss/packages/cli/dist/cli.js dev . +node /path/to/hyperframes-oss/packages/cli/dist/cli.js preview . ``` Replace `/path/to/hyperframes-oss` with your actual monorepo path. @@ -76,7 +76,7 @@ npm pack mkdir /tmp/pack-test && cd /tmp/pack-test npx /path/to/hyperframes-oss/packages/cli/hyperframes-.tgz init my-video cd my-video -npx /path/to/hyperframes-oss/packages/cli/hyperframes-.tgz dev . +npx /path/to/hyperframes-oss/packages/cli/hyperframes-.tgz preview . ``` ## Testing the fix branches diff --git a/docs/guides/troubleshooting.mdx b/docs/guides/troubleshooting.mdx index ff8351f5e2..85504eaa9c 100644 --- a/docs/guides/troubleshooting.mdx +++ b/docs/guides/troubleshooting.mdx @@ -61,11 +61,11 @@ If your issue is about a specific coding mistake (animations not working, video - Make sure you are editing the `index.html` in the project directory. The [preview server](/packages/cli#dev) watches for file changes and auto-reloads. + Make sure you are editing the `index.html` in the project directory. The [preview server](/packages/cli#preview) watches for file changes and auto-reloads. If changes still do not appear: - 1. Check the terminal for errors from the dev server + 1. Check the terminal for errors from the preview server 2. Stop and restart `npx hyperframes preview` 3. Hard-refresh the browser: **Ctrl+Shift+R** (Windows/Linux) or **Cmd+Shift+R** (macOS) 4. Clear the browser cache if CSS changes are not reflected diff --git a/docs/packages/cli.mdx b/docs/packages/cli.mdx index 53fe20f62f..ea33c4836e 100644 --- a/docs/packages/cli.mdx +++ b/docs/packages/cli.mdx @@ -243,7 +243,7 @@ This is suppressed in CI environments, non-TTY shells, and when `HYPERFRAMES_NO_ Opens your composition in the Hyperframes Studio with live preview. Edits to `index.html` and any referenced sub-compositions are reflected automatically. The preview uses the same Hyperframes runtime as production rendering, so what you see is what you get. - The dev server runs in three modes, auto-detected: + The preview server runs in three modes, auto-detected: 1. **Embedded mode** (default for `npx`) — runs a standalone server with the studio bundled in the CLI. Zero extra dependencies. 2. **Local studio mode** — if `@hyperframes/studio` is installed in your project's `node_modules`, spawns Vite with full HMR for faster iteration.