Skip to article
Public docs

Shiplet documentation

Publish on managed hosting, review safely, revise portable packages, and understand exactly where code runs and who owns it.

OpenAPI JSON Open app
Browse documentation
Workflows

WordPress

Embed Shiplet review mode on a WordPress site's original URLs.

Shiplet for WordPress connects one exact site origin to one Shiplet. Authorized reviewers leave contextual feedback on the site's original URLs.

Install and connect

The plugin is currently source-checkout-only. There is no official public download, registry listing, versioned zip, or checksum yet. From an authorized Shiplet source checkout, use wordpress/shiplet; otherwise wait for an official distribution rather than installing an unverified archive.

  1. Upload the source checkout's wordpress/shiplet directory to /wp-content/plugins/shiplet.
  2. Activate Shiplet, then open Settings → Shiplet.
  3. Choose Connect to Shiplet, sign in, and select an editable Shiplet.

The administrator connection uses short-lived, single-use codes. WordPress stores a revocable installation secret on the server; it places no organization key in public page source.

Start review mode

https://example.com/pricing/?shiplet-review=1

Shiplet verifies the reviewer and exact origin, then mounts review controls for that tab. Ordinary visitors do not see the controls or download the remote review client.

Disconnect

Choose Disconnect Shiplet. The origin immediately loses new session exchange and CORS access; short-lived browser capabilities expire. Production sites require HTTPS, and multisite installations connect each site independently.

Next: choose the Shiplet in the app, test a harmless staging comment, and verify reviewer access and secret boundaries.