Overview

What viz is for

viz checks whether a website still looks the way you expect after a change. It crawls a site, takes screenshots at your chosen viewports, compares them with approved baselines, then shows the pages that changed.

Use it when you want a visual safety net for:

• shared layouts and design systems
• important landing pages
• pricing, signup, account or checkout pages
• pull requests with preview deployments

The normal flow

1. Create a test suite for a site.
2. Let viz discover pages from the sitemap and links.
3. Choose the pages you want to track.
4. Run the suite once to create baselines.
5. Run it again after changes.
6. Review diffs and approve the ones that are expected.

The main ideas

Test suite is the long-lived setup for a website. It stores the base URL, tracked pages and run settings.

Tracked pages are the pages viz screenshots and compares. Newly discovered pages are not automatically tracked.

Run is one execution of a suite. A run can pass, find visual changes, fail to execute, or wait for review.

Baseline is the approved screenshot for one page at one viewport. When you approve a changed screenshot, it becomes the new baseline.

Review state is separate from run status. A run can finish successfully and still need review because visual changes were found.

Where to go next

Start with Create a Test Suite, then read Run and Review before inviting other people into the approval flow.