docs: fix preview port in DOCS_GUIDELINES example - #2903
Conversation
|
@santhiprakash can you add all the docs incoherences in one pr instead of making multiple prs pls? |
|
Thanks @miguel-heygen — understood. We'll consolidate the docs fixes into this single PR (including the Cursor link updates from #2771) instead of opening more docs-only PRs, then close the duplicate. Going forward we'll batch docs incoherences into one PR for Hyperframes. |
|
@miguel-heygen consolidated here: preview-port fix in |
- Problem: DOCS_GUIDELINES showed preview at localhost:3000 with stale "Server running" / "Watching for changes" output. - Fix: Align with packages/cli/README.md — default port 3002 and the actual "Studio running at" summary line. - Verification: diff checked against packages/cli/README.md port 3002.
8669554 to
265e535
Compare
|
Rebased onto current |
Problem
DOCS_GUIDELINES.mdtells doc authors to shownpx hyperframes previewoutput as:The CLI default preview port is 3002 (
packages/cli/src/commands/preview.tsargs.port.default), and the actual startup summary matchespackages/cli/README.md(Studio running at http://localhost:3002). Self-sourced docs drift.Triage / Root cause
The guidelines example predates the current preview default and output format. Sibling docs (
packages/cli/README.md,docs/guides/video-editor-cheatsheet.mdx) already use port 3002.Fix
Update the DOCS_GUIDELINES "Show expected output" example to use port 3002 and the current summary line.
Verification
python3 ../open-source/scripts/preflight_ship.py --repo heygen-com/hyperframes --local . --branch main --file DOCS_GUIDELINES.md --must-contain 'localhost:3000' --must-not-contain 'localhost:3002' --search 'DOCS_GUIDELINES preview port 3002'→ preflight clearbun run format:check -- DOCS_GUIDELINES.md→ passedgpgsigpresent on0e84008da)Notes / Risks
Docs-only; no behavior change. Sibling to merged #2901/#2902 (studio monorepo port 5190).