docs(studio): document monorepo dev server port - #2902
Merged
miguel-heygen merged 1 commit intoJul 30, 2026
Conversation
- Problem: @hyperframes/studio package docs showed bun run dev without the localhost URL contributors need after heygen-com#2901 fixed contributing.mdx only. - Fix: note that the studio dev server listens on localhost:5190 per packages/studio/vite.config.ts server.port. - Verification: preflight_ship.py + read vite.config.ts; bun run format:check.
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
After #2901 fixed the contributing setup guide to use
http://localhost:5190, the@hyperframes/studiopackage docs still showedbun run devwithout telling contributors which URL to open. The actual port is5190inpackages/studio/vite.config.ts(server.port).Self-sourced docs drift.
Triage / Root cause
docs/packages/studio.mdx"From the monorepo" section omitted the dev-server URL whiledocs/contributing.mdxwas corrected in #2901.Fix
Add one sentence noting the studio dev server listens on
http://localhost:5190, with a pointer topackages/studio/vite.config.tsserver.port.Verification
python3 ../open-source/scripts/preflight_ship.py --repo heygen-com/hyperframes --local . --branch main --file docs/packages/studio.mdx --must-contain 'bun run dev' --must-not-contain 'localhost:5190' --search 'studio port 5190'→ preflight clear before editbun run format:check -- docs/packages/studio.mdx→ passedNotes / Risks
Sibling to merged #2901 (contributing guide only). No behavior change.