# Framecheck

> User documentation for Framecheck visual regression and accessibility testing. Preview pages describe work not generally available yet.

## Start here

- [Welcome to Framecheck](https://docs.framecheck.dev/index.md): Test your Storybook, understand every change, and ship with confidence.
- [Quickstart](https://docs.framecheck.dev/quickstart.md): Connect a Storybook and complete your first visual review.
- [Projects, runs, and baselines](https://docs.framecheck.dev/concepts.md): Understand the terms you will see in Framecheck.
- [Feature availability](https://docs.framecheck.dev/availability.md): Know which workflows are available and which are still in preview.

## Connect your workflow

- [GitHub Actions](https://docs.framecheck.dev/github-actions.md): Add the generated workflow and keep pull requests and baselines in sync.
- [Other CI systems](https://docs.framecheck.dev/other-ci.md): Upload from Bitrise or another CI with explicit commit metadata.
- [Uploader CLI](https://docs.framecheck.dev/cli.md): Install the web uploader, authenticate, and understand its commands and exit codes.
- [Upload tokens](https://docs.framecheck.dev/tokens.md): Create, rotate, and revoke the credentials used by CI.
- [When Framecheck runs](https://docs.framecheck.dev/skip-rules.md): Skip selected pull requests before building Storybook.

## Review and collaborate

- [Reviewing changes](https://docs.framecheck.dev/review.md): Inspect results, accept intentional changes, and send regressions back for a fix.
- [Baselines and approvals](https://docs.framecheck.dev/baselines.md): Keep comparisons meaningful as pull requests merge and new commits arrive.
- [Policies and GitHub checks](https://docs.framecheck.dev/policies.md): Choose how visual and accessibility results affect pull requests.
- [Comments and change requests](https://docs.framecheck.dev/collaboration.md): Keep review discussion with the images it concerns.
- [Live preview and page structure](https://docs.framecheck.dev/live-review.md): Investigate the story behind a screenshot without changing its captured result.
- [Keyboard shortcuts](https://docs.framecheck.dev/keyboard-shortcuts.md): Move through a visual review without reaching for the mouse.
- [Component library](https://docs.framecheck.dev/component-library.md): Browse the accepted state of your design system, outside a single run.
- [Runs, retries, and cancellation](https://docs.framecheck.dev/runs.md): Follow a build from upload to review and recover when capture fails.

## Configure capture

- [Capture settings](https://docs.framecheck.dev/capture-settings.md): Choose browsers, rendering defaults, and the resources your stories can load.
- [Story parameter reference](https://docs.framecheck.dev/story-parameters.md): Control capture for an individual story, component, or preview.
- [Viewports and modes](https://docs.framecheck.dev/viewports-modes.md): Test responsive layouts and themed variants of the same story.
- [Stable stories](https://docs.framecheck.dev/stable-stories.md): Make a screenshot change only when the component changes.
- [Ignore regions](https://docs.framecheck.dev/ignore-regions.md): Exclude intentionally variable pixels while keeping the rest of a component covered.
- [Unstable stories and quarantine](https://docs.framecheck.dev/unstable-stories.md): Keep noisy stories visible while protecting the rest of your review workflow.
- [Smart Snapshots](https://docs.framecheck.dev/smart-snapshots.md): Reduce pull-request capture work while keeping every story accounted for.

## Accessibility and integrations

- [Accessibility checks](https://docs.framecheck.dev/accessibility.md): Find common accessibility problems and review new or worsened findings.
- [Storybook addon](https://docs.framecheck.dev/storybook-addon.md): See Framecheck results while working inside your local Storybook.
- [Notifications](https://docs.framecheck.dev/notifications.md): Choose where your team hears about runs and review requests.
- [Webhook reference](https://docs.framecheck.dev/webhooks.md): Receive signed Framecheck events in your own tools.
- [Migrating from Chromatic](https://docs.framecheck.dev/migrate-chromatic.md): Bring an existing Storybook workflow across and review the first baseline deliberately.

## React Native

- [React Native overview](https://docs.framecheck.dev/react-native.md): Choose web-rendered coverage or prepare native Android and iOS capture.
- [Native capture mode](https://docs.framecheck.dev/native-capture-mode.md): [Preview] Prepare your on-device Storybook to run without its development UI.
- [Android capture](https://docs.framecheck.dev/android.md): [Preview] Build and upload a standalone Android Storybook APK.
- [iOS capture](https://docs.framecheck.dev/ios.md): [Preview] Upload an unsigned Apple Silicon simulator build of your Storybook app.
- [Native CI and uploader](https://docs.framecheck.dev/native-ci.md): [Preview] Coordinate Android and iOS artifacts across GitHub Actions, Bitrise, and custom pipelines.
- [Native appearance and story layout](https://docs.framecheck.dev/native-appearance.md): [Preview] Control light/dark capture, safe areas, and the status bar.
- [Local native capture and packaging](https://docs.framecheck.dev/native-cli.md): [Preview] Debug a native story locally before sending a build to hosted capture.

## Manage your company

- [Teams and roles](https://docs.framecheck.dev/teams.md): Give each teammate the access they need.
- [Account and security](https://docs.framecheck.dev/account-security.md): Manage sign-in, two-factor authentication, and connected applications.
- [Billing and usage](https://docs.framecheck.dev/billing.md): Understand allowances, extra usage, and why a run may be paused.
- [Data, retention, and sharing](https://docs.framecheck.dev/data-retention.md): Know what your team uploads and who can access it.
- [Custom-domain Storybook](https://docs.framecheck.dev/publish-storybook.md): [Preview] Prepare a dedicated domain for saved Storybook builds when publishing becomes available.
- [Managing projects](https://docs.framecheck.dev/project-lifecycle.md): Update settings, archive unused work, and restore access deliberately.
- [Joining by email domain](https://docs.framecheck.dev/company-domains.md): Let people with verified company email addresses request or receive access.

## Help and reference

- [Troubleshooting](https://docs.framecheck.dev/troubleshooting.md): Find the likely cause and the next action for a blocked workflow.
- [Compatibility and limits](https://docs.framecheck.dev/limits.md): Plan coverage and understand the boundaries of a run.