From e4c29e487e87c157b861da31ee894f76144befe1 Mon Sep 17 00:00:00 2001 From: ARPAN MONDAL Date: Tue, 12 May 2026 16:06:24 +0530 Subject: [PATCH] docs(mintlify): scope live preview to port 3000 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) --- docs/getting-started/core-concepts.mdx | 2 +- docs/live-preview-architecture.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/getting-started/core-concepts.mdx b/docs/getting-started/core-concepts.mdx index 3edd354..2db8be5 100644 --- a/docs/getting-started/core-concepts.mdx +++ b/docs/getting-started/core-concepts.mdx @@ -44,7 +44,7 @@ Templates define reusable sandbox settings such as image, provider, memory, vCPU ## Live Previews -Live previews expose web applications running inside a sandbox through a preview URL. This is useful for coding agents that need to build and inspect web apps. +Live previews expose a web application running inside a sandbox through a preview URL. This is useful for coding agents that need to build and inspect web apps. Today the Docker provider routes port `3000` only via Traefik; configurable ports are on the roadmap. See [Live Preview Architecture](/docs/live-preview-architecture) for details. ## Quotas diff --git a/docs/live-preview-architecture.md b/docs/live-preview-architecture.md index a40195f..f466e0b 100644 --- a/docs/live-preview-architecture.md +++ b/docs/live-preview-architecture.md @@ -4,10 +4,10 @@ To implement a production-grade, highly scalable "Live Preview" system for 100+ concurrent users entirely powered by **Traefik**. This design supports seamless local development (`*.localhost`) and production environments (`*.stacyide.xyz`), using Traefik's native dynamic discovery. ## Status: Implemented (Phase 1 & 2) -StacyVM now supports automatic Traefik integration for the Docker provider. Preview URLs can be generated via the SDK using `sandbox.getPreviewUrl(port)`. +StacyVM now supports automatic Traefik integration for the Docker provider. Preview URLs can be generated via the SDK using `sandbox.getPreviewUrl(port)`. **Today only port 3000 is routed** (see Traefik labels below); the SDK signature accepts any int, but URLs for other ports will not resolve. Configurable ports are tracked on the roadmap. ## Background & Motivation -StacyVM sandboxes need a way to expose internal web servers (e.g., Vite on 5173, Next.js on 3000) to external users. Traefik is an industry-standard dynamic reverse proxy that integrates natively with Docker. By using Traefik, we eliminate custom proxy code and leverage robust features like automatic SSL (Let's Encrypt), WebSocket support, and zero-downtime configuration updates. +StacyVM sandboxes need a way to expose an internal web server (today: port 3000, e.g., a Next.js dev server) to external users. Traefik is an industry-standard dynamic reverse proxy that integrates natively with Docker. By using Traefik, we eliminate custom proxy code and leverage robust features like automatic SSL (Let's Encrypt), WebSocket support, and zero-downtime configuration updates. ## Architecture