Skip to content

Docs: Remove more references to setProjectAnnotations #34049

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.

Sign up for GitHub

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

Merged
kylegach merged 1 commit into from
Mar 6, 2026
Merged

Docs: Remove more references to setProjectAnnotations #34049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 0 additions & 29 deletions docs/_snippets/addon-vitest-set-project-annotations-simple.md
View file
Open in desktop

This file was deleted.

7 changes: 6 additions & 1 deletion docs/writing-tests/accessibility-testing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,12 @@ Your Storybook will now include some features to check the accessibility of your
### Integration with Vitest addon

The accessibility addon is designed to integrate with the [Vitest addon](./integrations/vitest-addon/index.mdx), so that you can [run accessibility tests](#run-accessibility-tests) alongside your component tests.
No additional configuration is needed.

To get started, run this command, which will install and configure the Vitest addon and Vitest:

<CodeSnippets path="addon-test-install.md" />

The full installation instructions, including project requirements, are available in the [Vitest addon documentation](./integrations/vitest-addon/index.mdx#install-and-set-up).

## Check for violations

Expand Down
15 changes: 1 addition & 14 deletions docs/writing-tests/integrations/vitest-addon/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,7 @@ For some project setups, the `add` command may be unable to automate the addon a
1. Make sure Vite and Vitest are configured in your project.
1. Configure Vitest to use [browser mode](https://vitest.dev/guide/browser/).
1. Install the addon, `@storybook/addon-vitest`, in your project and [register it in your Storybook configuration](../../../addons/install-addons.mdx#manual-installation).
1. Create a test setup file, `.storybook/vitest.setup.ts`. You can use the [example setup file](#example-vitest-setup) as a guide.
1. Adjust your Vitest configuration to include the plugin and reference the setup file. You can use the [example configuration files](#example-configuration-files) as a guide.
1. Adjust your Vitest configuration to include the plugin. You can use the [example configuration files](#example-configuration-files) as a guide.
- For projects with existing Vitest tests, we recommend using a separate [test project](https://vitest.dev/guide/projects) if you're using Vitest ≥ 4.0 and a [workspace file](https://v3.vitest.dev/config/#workspace) if you're using Vitest 3.x to define separate configurations for your Storybook tests and other tests. You can run them in isolation or together, depending on your needs.

</details>
Expand All @@ -94,18 +93,6 @@ For some project setups, the `add` command may be unable to automate the addon a

When the addon is set up automatically, it will create or adjust your Vitest configuration files for you. If you're setting up manually, you can use the following examples as a reference when configuring your project.

<details id="example-vitest-setup">
<summary>Example Vitest setup file</summary>

Storybook stories contain configuration defined in `.storybook/preview.js|ts`. To ensure that configuration is available to your tests, you can apply it in a Vitest setup file. Here's an example of how to do that:

{/* prettier-ignore-start */}

<CodeSnippets path="addon-vitest-set-project-annotations-simple.md" />

{/* prettier-ignore-end */}
</details>

<details id="example-vitest-config">
<summary>Example Vitest config file</summary>

Expand Down
Loading