Skip to content

docs(contributing): fix studio dev server port in setup guide - #2901

Merged
miguel-heygen merged 1 commit into
heygen-com:mainfrom
santhiprakash:docs/fix-contributing-studio-port
Jul 30, 2026
Merged

docs(contributing): fix studio dev server port in setup guide#2901
miguel-heygen merged 1 commit into
heygen-com:mainfrom
santhiprakash:docs/fix-contributing-studio-port

Conversation

@santhiprakash

@santhiprakash santhiprakash commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

What

Update the contributor setup guide to reference the correct studio dev server port.

Why

docs/contributing.mdx told new contributors to expect the studio at http://localhost:3000 after bun run dev, but the studio Vite dev server is configured for port 5190 in packages/studio/vite.config.ts. This causes false setup failures for contributors who follow the guide literally.

Self-sourced docs drift fix.

How

  • Change the verification URL in the "Run the studio" step from localhost:3000 to localhost:5190.
  • No behavior change — docs only.

Test plan

How was this tested?

  • Unit tests added/updated
  • Manual testing performed — read packages/studio/vite.config.ts (server.port: 5190) and confirmed upstream main still documents 3000
  • Documentation updated (if applicable)

Verification: python3 scripts/preflight_ship.py --repo heygen-com/hyperframes --local . --branch main --file docs/contributing.mdx --must-contain 'http://localhost:3000' --must-not-contain 'http://localhost:5190' --search 'contributing studio port localhost' → exit 0

- Problem: setup guide pointed contributors to localhost:3000 after bun run dev.
- Fix: use localhost:5190 to match packages/studio/vite.config.ts server.port.
- Verification: preflight_ship.py + read vite.config.ts server.port (5190).
@miguel-heygen
miguel-heygen merged commit ffe5e12 into heygen-com:main Jul 30, 2026
13 checks passed
miguel-heygen pushed a commit that referenced this pull request Jul 30, 2026
- Problem: @hyperframes/studio package docs showed bun run dev without the
  localhost URL contributors need after #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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants