Skip to content

docs(readme): a shorter quick start that reaches a sandbox, and a true status - #432

Merged
WaylandYang merged 1 commit into
devfrom
feature/readme-quick-start
Oct 31, 2026
Merged

WaylandYang merged 1 commit into
devfrom
feature/readme-quick-start

Conversation

@WaylandYang

@WaylandYang WaylandYang commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Quick start

  • The console was not there. cargo build alone embeds a page saying the console was not built. The console build now comes first, with its real floor: vite 8 needs Node 22.12 or later, and 22.11 fails.
  • It stopped before a sandbox. It now ends at a template from an image and a sandbox from it, instead of pointing at fleet.sh seed.
  • Shorter. Node pairing and --tls-san were already covered more fully in docs/API.md, so they become links. Each README is 10 lines shorter.

Status

  • The backend did not simply move to gVisor: Firecracker stayed as a second backend, chosen per node (ADR 11).
  • "Restore several snapshots in parallel" is ticked: create_workers() runs one per CPU. "Reserve capacity on the master" stays open, since placement still reads each node's last report.

Verified

On the bare-metal host, from a fresh git clone of dev at 3c3b245, default paths:

  • Without the npm step the console page says it was not built. With Node 22.12.0 it serves 407 KB and contains "+ From an image".
  • API: template from an image in 4 s, sandbox created, first exec answered 4, deleted with 204.

Not verified:

  • That API flow used an image from a local registry, because this host cannot reach Docker Hub. The console's sign-in and "+ From an image" were not clicked through.
  • --port-min 40000 --port-max 41000 was added, because sst-fc on that host holds part of the default range.
  • The fleet block is unchanged and was not rerun.

🤖 Generated with Claude Code

…e status

The quick start stopped before the first sandbox and sent readers to
`fleet.sh seed` for a template, from before templates could come from an
image. It also promised a console that `cargo build` alone does not embed.
Build the console first, and end at a sandbox made from an image.

Node pairing and --tls-san move to docs/API.md, which already covers both.

Status said the backend moved to gVisor; Firecracker stayed as a second
backend (ADR 11). Parallel restores are done, so that item is ticked.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: WaylandYang <145302500+WaylandYang@users.noreply.github.com>
@WaylandYang
WaylandYang merged commit ce5beff into dev Oct 31, 2026
5 checks passed
@WaylandYang
WaylandYang deleted the feature/readme-quick-start branch October 31, 2026 20:27
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.

1 participant