Skip to content

Update screenshots

Screenshots support instructions but do not replace steps and expected results. Capture only stable screens and use a dedicated test project with no customer data.

Requirements

  • Docker;
  • a running Threadory web interface;
  • a test user with the required role;
  • Chromium from the Playwright image matching the @playwright/test version.

Public screen

DOCS_BASE_URL=https://example.test \
DOCS_PUBLIC_ONLY=1 \
npm --prefix apps/web run docs:screenshots

Authenticated screens

Pass credentials only as process environment variables. Do not save them in .env, shell history, Markdown, or CI artifacts.

DOCS_BASE_URL=https://example.test \
DOCS_SCREENSHOT_EMAIL=docs-user@example.test \
DOCS_SCREENSHOT_PASSWORD='temporary-password' \
npm --prefix apps/web run docs:screenshots

The script writes PNG files to docs/assets/screenshots/. Inspect every file before publishing: it must not contain email addresses, tokens, internal URLs, real customer names, or unrelated data from neighboring projects.