DOCS / OVERVIEW

Documentation

Purley compares what your CMS says should exist against what your host actually built, and gives you a few tools for the gap between the two. Every feature lives on a tab inside a project.

How the app is laid out

Everything sits inside an organisation. Every account gets one on signup, on the Free plan; upgrading it to Pro unlocks every tool, scheduled checks and team members. Inside an organisation you create projects, and each project is one Prismic repository paired with one Vercel project.

Opening a project shows a row of tabs. The SETTINGS button in the top right of the same page opens the project configuration panel, which is where credentials, routes and languages live. If a project has no Vercel token saved yet, that panel opens automatically and a banner points you at it.

Start here

  • Setup guide - credentials, routes, resolvers, languages, scheduled checks and organisation settings.

What each tab does

TabWhat it does
url_auditLists URLs that exist in Prismic but were never built by Vercel.
broken_linksScans every document for links that point nowhere, internal or external.
link_finderFinds every document that references a given UID.
sitemapBuilds a sitemap.xml from the pages in your latest Vercel build.
redirectsEdits and publishes your Vercel redirect list without touching config files.
webhooksBatches rapid publish events into a single deploy.
buildsShows recent deployments and, for failures, the errors behind them.
datadogRuns your Datadog Synthetic tests against each successful production deploy.

What each tab needs configured

Not every tab needs the full configuration. This is the minimum for each one to work:

TabRequires
url_auditPrismic repository, Vercel project ID and token, at least one route
broken_linksPrismic repository
link_finderPrismic repository
sitemapVercel project ID and token
redirectsVercel project ID and token
webhooksNothing - it only needs a deploy hook URL to call
buildsVercel project ID and token
datadogVercel project ID and token, plus Datadog API and application keys

A note on API usage

The url_audit and broken_links scans page through every document in your repository and pull the full build log of your most recent deployment. Both ask for confirmation before running, because on a large repository they use a noticeable amount of Prismic and Vercel API quota. Scheduled checks have the same cost on every run, so pick the longest interval you can live with.