Skip to article
Public docs

Shiplet documentation

Prepare an artifact, share its review link, and bring contextual feedback back to your team or agent.

Browse documentation
Review

The review layer

Understand the toolbar around an artifact and how Shiplet keeps its controls separate.

The artifact is the work your team reviews. Shiplet provides the review layer around it. The layer owns the toolbar, reviewer actions, and feedback workflow attached to the Shiplet.

The review layer stays separate from the artifact. Updating its controls does not rewrite the page, file, build, or public URL under review.

Built-in toolbar

The default toolbar lets reviewers select a page or visible element, leave a comment, open existing tickets, and update review status when their access allows it.

Custom review widgets

A team can attach a custom widget when the built-in controls do not match its process. Shiplet runs the widget in a sandboxed frame beside the artifact and presents protected changes through trusted confirmation.

Custom widget code cannot identify the reviewer or approve its own request. Its files stay inside that Shiplet's review layer.

  1. Use Code Mode to read the current review-layer files and version.
  2. Send widget-relative changes to the preview endpoint. Shiplet validates them and returns an expiring preview link without changing the live review.
  3. Apply the preview with the original version and explicit approval.

The API accepts widget files and paths. This workflow does not expose artifact files, and applying a preview leaves the artifact unchanged. Run search in Code Mode MCP for the current schemas.

Browser resource boundary

The widget sandbox limits origin and authority. It does not impose a separate heap, CPU, or lifetime quota in the browser process. Reload or close a review if custom widget code makes the tab unresponsive, then use the built-in controls until an owner repairs it.

Next: read Security and isolation.