Skip to content

docs(cloud): add an Images group for your own images - #48

Draft
silverzki wants to merge 2 commits into
boxlite-ai:mainfrom
silverzki:docs/cloud-images
Draft

silverzki wants to merge 2 commits into
boxlite-ai:mainfrom
silverzki:docs/cloud-images

Conversation

@silverzki

@silverzki silverzki commented Oct 10, 2026 •

Copy link
Copy Markdown

TL;DR

New Cloud > Images group: run boxes from your own images, with tested examples in four languages.

What changes

  • New page cloud/images, ordered like the Modal images guide: catalog, public and private registries, pinned tags, limits, errors.
  • Each example is one script in Python, Node.js, Go, and REST.
  • Nav: Cloud > Images holds box-images and the new page.
  • boxes, box-images, vs-opensource, agent-service-endpoint no longer say REST has no image operations.
  • Reviewed against the boxlite-doc-writer skill: task-first opening, prerequisites before code, parameter tables, exact error messages.

Verification

  • Three examples ran on a local stack from the latest boxlite code; the private-image one ran on a development deployment.
  • Every quoted error message came from a real run, except the vanished-upstream one, which is quoted from the API source.
  • Rendered and checked in dark, light, and 390px width.
  • Docs lint, llms.txt check, mint validate, mint broken-links pass.

Before merging

  • Draft until POL-543 to POL-547 reach production (boxlite #1547, #1605, and the POL-544/546/547 PRs).
  • Then re-check on production: admitted registries, login registries, the 20-image limit, curated short names.

🤖 Generated with Claude Code

The REST runtime now manages an organization's image catalog, private
registry logins, and tag moves, and the Cloud tab still said image
operations are not supported over REST.

A new Cloud > Images group holds the existing "Choose an image" page and
a new page, "Run boxes from your own images", written in the order of
Modal's images guide: one complete example first, then one capability
per section. It covers what the catalog records and when, public
registries, reading the catalog, private registry logins, pinning and
rolling back a tag, upstream changes and vanished versions, the image
limit, the console's images, key permissions, and errors. Each example
is one script in Python, Node.js, Go, and REST.

The four pages that said REST has no image operations now say only
that there is no pull step, and link to the new page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 10, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Symptom: reviewed against the boxlite-doc-writer skill, the page opened
with a description, not a task; listed prerequisites after its first
example; had no parameter tables for move_tag or registries.create;
quoted four error strings from source alone; and repeated its own
description as the first paragraph.

Changes:
- The opening says what you get, and prerequisites come before the
  first example.
- move_tag and registries.create get Parameter / Type / Default /
  Description tables.
- Pull failures, a refused digest, a tagged name, and pull() quote the
  exact SDK messages, prefixes included.
- A warning, beside the step, that a create failing on its image
  leaves the box behind, and how to remove it by name.

Evidence: each quoted message was produced by a REST runtime against
a stack built from the latest boxlite code; removing a leftover box by
name was run there too. The page was viewed rendered in dark and light
themes and at a 390px width.

Not changed: the vanished-upstream message is still quoted from the
API source, because it needs a registry to delete a build a runner has
not cached. The registry list, the image limit, and the curated short
names still need a check on production before merge.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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