docs(mintlify): scope live preview to port 3000 - #6
Merged
Conversation
Follow-up to PR #5 (README honesty pass). The Mintlify docs had the same port-scope overclaim: - docs/live-preview-architecture.md mentioned "Vite on 5173, Next.js on 3000" in the motivation, implying multi-port support, while the same file's Traefik label example hardcodes port 3000 only. - The status line referenced sandbox.getPreviewUrl(port) without noting that only port 3000 actually routes today; the SDK signature accepts any int but URLs for other ports do not resolve. - docs/getting-started/core-concepts.mdx described Live Previews generically with no port scope. Now all three places say "port 3000 today; configurable ports on the roadmap" and core-concepts links to the architecture doc. No code changes. Documentation only. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
1 participant
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.
What
Mintlify follow-up to #5 (README honesty pass). Scopes the live-preview port claim in the docs site to match the actual implementation.
Why
The Mintlify docs had the same port-scope overclaim the README did:
docs/live-preview-architecture.md— the Background section listed "Vite on 5173, Next.js on 3000" as supported targets, implying multi-port. The very same file's Traefik label example one section down hardcodes port 3000 only.docs/live-preview-architecture.md— the Status line describedsandbox.getPreviewUrl(port)without flagging that only port 3000 actually routes today. The SDK signature accepts any int but URLs for non-3000 ports silently don't resolve.docs/getting-started/core-concepts.mdx— the Live Previews section was generic with no port scope.What this PR does
docs/live-preview-architecture.md: status line now says "Today only port 3000 is routed... Configurable ports are tracked on the roadmap."; motivation rewritten from "expose internal web servers (e.g., Vite on 5173, Next.js on 3000)" to "expose an internal web server (today: port 3000, e.g., a Next.js dev server)"docs/getting-started/core-concepts.mdx: Live Previews section gets a one-line port-3000 scope note and a link to the architecture docWhat this PR does NOT do
internal/providers/docker.go:168-171is unchanged. Configurable preview ports remain a v0.2 roadmap item (already tracked in docs(readme): walk back unimplemented claims, link 28ms proof #5).phase-14-worker-identity-hardeningbranch links indocs/tutorials/code-runner.mdx,docs/tutorials/typescript-code-runner.mdx,docs/getting-started/prerequisites.mdx. That's unrelated cleanup — separate PR.Diff size
2 files, +3 / -3 lines. Should pass any Mintlify build trivially since it's prose-only inside existing sections.
Audit notes (for reviewer confidence)
While doing this honesty pass on the docs site, I also greped for the other two README issues — both came back clean:
pool_securitydead knobs (per_user_uid,pid_namespace,workspace_permissions,hidepid): zero mentions in the entiredocs/tree, includingsecurity-governance.md,threat-model.md,admin-control-plane.md,production-readiness.md. No follow-up docs work needed.core-concepts.mdxdescribes capabilities without a count.docs/snapshot-restore.mdalready has full methodology, reproduction numbers (28/29/33ms across 3 concurrent spawns), and a file/symbol reference table. Consistent with the new README.Follow-ups (tracked separately)
phase-14-worker-identity-hardeningbranch links in tutorials and prerequisites — should point atmainor a tagged releasepool_securityknobs (docs(readme): walk back unimplemented claims, link 28ms proof #5 follow-up)