Question 1

What exactly does the "Gatekeeper" do?

Accepted Answer

The Gatekeeper is a GitHub Status Check. When your CI/CD pipeline runs `poliage publish`, we detect if any visual assets have changed. If they have, we post a "Pending" status to your Pull Request, effectively blocking the merge. Once a Product Manager or Designer approves the visual in the Poliage dashboard, the status turns green, allowing the code to be merged.

Question 2

How do the "Unbreakable URLs" work?

Accepted Answer

We provide a single CDN URL for every visual (e.g., `cdn.poliage.com/...`). This URL never changes. Behind the scenes, it dynamically redirects to the latest approved version of your image or video. This means you never have to update `<img>` tags in your documentation when you update your product.

Question 3

Can I use Poliage for video documentation?

Accepted Answer

Yes. You can capture short, looping clips (MP4/GIF) using the CLI. These are treated just like screenshots—they are versioned, diffed (manually), and served via our CDN.

Question 4

Why does Poliage run in my CI/CD instead of your cloud?

Accepted Answer

Security and reliability. By running `poliage run` in your own environment (GitHub Actions, GitLab CI), we can access your staging environment, use your seeded data, and access `localhost` servers without you ever having to give us network access or database credentials.

Question 5

My CI/CD pipeline is failing on `poliage run`. Why?

Accepted Answer

Ensure you have installed the necessary Playwright dependencies in your runner. Usually, adding `npx playwright install --with-deps` before the Poliage step fixes this. Also, verify your `POLIAGE_API_KEY` is set correctly in your CI secrets.

Question 6

How do I record a new visual scenario?

Accepted Answer

Run `poliage record` in your local terminal while your local development server is running. This will launch an interactive session where you can click through your app to generate the config steps automatically.

Question 7

Does Poliage have access to my source code?

Accepted Answer

No. The `@docsync/cli` runs inside your environment. We only receive the binary assets (images/videos) and the commit messages you choose to publish. We do not have read access to your private codebase.

Question 8

How do I delete my data?

Accepted Answer

You can delete a project at any time from Project Settings > General > Danger Zone. This initiates a "Soft Delete." All data, including files stored in Cloudflare R2, will be permanently purged after 30 days.

Question 9

Where is my data hosted?

Accepted Answer

Platform metadata is stored in the US (Supabase). Asset files are stored in global object storage (Cloudflare R2).

Question 10

What counts as a "Managed Visual"?

Accepted Answer

A Managed Visual is a unique key in your `docsync.config.json` file (e.g., `admin-dashboard`). You can have hundreds of versions of that dashboard in history, but it only counts as 1 Managed Visual against your plan limit.

Question 11

What happens if I exceed my bandwidth limit?

Accepted Answer

We do not hard-block your assets. If you consistently exceed fair usage policies on the Pro plan, we will reach out to discuss Enterprise options or Bring Your Own Storage (BYOS).

Support Center

Common Questions

General & Workflow

CLI & Automation

Security & Privacy

Billing

Still have questions?