Skip to content

Images and screenshots

Sequre Forms uses two image workflows because marketing pages and technical documentation have different publishing needs.

The Website Image field is available for marketing-page hero images and inside the page body.

  1. Upload or select an image in Sanity Studio.
  2. Add alternative text that describes the useful information in the image.
  3. Mark the image as decorative only when it communicates no information.
  4. Use the hotspot tool to keep the important part visible when the image is cropped.
  5. Add an optional caption and select Content, Wide, or Full width.
  6. Publish the page so the webhook can rebuild the Cloudflare Pages site.

The website generates responsive image URLs from the Sanity asset. A single good-quality source is normally enough for mobile, tablet, and desktop delivery.

Technical screenshots stay in Git with the Starlight documentation so a screenshot change can be reviewed alongside the instructions that depend on it. Store them under src/assets/docs/ in a folder named after the relevant guide.

Use a relative Markdown image reference:

![Form builder showing the field validation panel](../../../../assets/docs/form-builder/validation-panel.png)

The exact number of ../ segments depends on the Markdown file’s directory. Preview the docs locally before publishing to confirm the path.

  • Capture only the relevant application area and remove customer or personal data.
  • Use PNG for interface screenshots and JPEG only for photographic material.
  • Keep the source screenshot large enough to remain readable on a wide desktop.
  • Write alternative text that explains what the reader should notice.
  • Update the screenshot whenever the documented interface materially changes.
  • Avoid embedding labels into the bitmap when normal documentation text can explain the step.

Sanity-hosted images can still be referenced by URL in Markdown for exceptional shared assets, but versioned local screenshots are the default for product documentation.