Skip to content

Add Chromatic overview documentation #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions docusaurus/docs/chromatic/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Chromatic Overview

Chromatic is a powerful visual testing and review platform designed to streamline the UI development process. This overview will introduce you to Chromatic's key features and how it integrates with your development workflow.

## What is Chromatic?

Chromatic is a tool that helps developers and designers ensure visual consistency and catch UI bugs before they reach production. It works by automatically capturing screenshots of your UI components and pages, then comparing them against previous versions to detect visual changes.

## Key Features

### 1. Visual Testing

Chromatic automatically captures screenshots of your UI components and compares them to previous versions. This allows you to:

- Detect unintended visual changes
- Ensure consistency across different browsers and devices
- Catch UI regressions before they reach production

### 2. UI Review

Chromatic provides a collaborative platform for reviewing UI changes:

- Side-by-side comparisons of UI changes
- Comment and annotate directly on screenshots
- Approve or request changes for UI updates

### 3. Storybook Integration

Chromatic seamlessly integrates with Storybook, allowing you to:

- Automatically capture screenshots of your Storybook stories
- Run visual tests on individual components
- Maintain a living style guide of your UI components

### 4. Continuous Integration

Chromatic can be easily integrated into your CI/CD pipeline:

- Automatically run visual tests on every pull request
- Block merges if visual changes are detected and not approved
- Ensure visual consistency throughout your development process

## Getting Started

To start using Chromatic with your project, follow these steps:

1. Install the Chromatic CLI in your project
2. Configure Chromatic to work with your Storybook setup
3. Run your first build and review the results
4. Integrate Chromatic into your CI/CD pipeline

For detailed instructions on setting up and using Chromatic, please refer to the official Chromatic documentation.

## Conclusion

Chromatic is a valuable tool for teams looking to maintain high-quality, consistent UIs across their applications. By integrating visual testing and review into your development workflow, you can catch UI bugs early, streamline collaboration between developers and designers, and ensure a consistent user experience across your product.