docs: fix preview port in DOCS_GUIDELINES example - #2903
Open
santhiprakash wants to merge 2 commits into
Open
Conversation
- 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: bun run format:check -- DOCS_GUIDELINES.md → passed.
Collaborator
|
@santhiprakash can you add all the docs incoherences in one pr instead of making multiple prs pls? |
Contributor
Author
|
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. |
- Problem: guide links still pointed at the legacy cursor.sh domain. - Fix: switch both docs references to cursor.com so users land on the canonical homepage directly. - Verification: bunx oxfmt --check on the two edited MDX files.
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.
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).