User Docs

Create a Test Suite

Set up a crawl-based suite and choose the pages to track.

Before you start

Have the website URL ready. Use the public URL that people normally visit, for example https://example.com. The site should be reachable from the worker environment.

If the site blocks bots, make sure the configured user agent and network allow viz to visit it.

Create the suite

  1. Open Test Suites.
  2. Choose New test suite.
  3. Add a clear name.
  4. Paste the base URL.
  5. Adjust the crawl and screenshot settings if you need to.
  6. Create the suite.

viz queues a discovery crawl as soon as the suite is created. The crawl finds pages from the sitemap and same-origin links.

Pick tracked pages

After the crawl finishes, open the suite and review the discovered pages.

  • Track pages that should be protected by screenshots.
  • Leave utility pages, noisy pages or unimportant pages untracked.
  • Acknowledge new pages if you have seen them but do not want to track them.
  • Delete removed pages when they no longer matter.

Tracked pages are the only pages included in normal suite runs.

Create the first baselines

Once at least one page is tracked, start a run. If no baseline exists yet, the first screenshot for each tracked page and viewport becomes the approved baseline.

After that, later runs compare against those baselines.

Good suite habits

  • Start with the most important pages rather than the whole site.
  • Keep the viewport list small at first.
  • Use custom CSS to hide dynamic content such as adverts, chat widgets, carousels or timestamps.
  • Keep the suite name human-readable, especially if it is linked to a GitHub repo.