Core: Define checklist tasks #32799

ghengeveld · 2025-10-23T07:16:17Z

See #32644
Telescopes on #32874

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

stories
unit tests
integration tests
end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

Add or update documentation reflecting your changes
If you are deprecating/removing a feature, make sure to update
MIGRATION.MD

Checklist for Maintainers

When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
- bug: Internal changes that fixes incorrect behavior.
- maintenance: User-facing maintenance tasks.
- dependencies: Upgrading (sometimes downgrading) dependencies.
- build: Internal-facing build tooling & test updates. Will not show up in release changelog.
- cleanup: Minor cleanup style change. Will not show up in release changelog.
- documentation: Documentation only changes. Will not show up in release changelog.
- feature request: Introducing a new feature.
- BREAKING CHANGE: Changes that break compatibility in some way with current major version.
- other: Changes that don't fit in the above categories.

🦋 Canary release

This pull request has been released as version 0.0.0-pr-32799-sha-056a80fc. Try it out in a new sandbox by running npx [email protected] sandbox or in an existing project with npx [email protected] upgrade.

More information


Published version	`0.0.0-pr-32799-sha-056a80fc`
Triggered by	@ghengeveld
Repository	storybookjs/storybook
Branch	`checklist-tasks`
Commit	`056a80fc`
Datetime	Mon Nov 10 21:54:37 UTC 2025 (`1762811677`)
Workflow run	19247345540

To request a new release of this pull request, mention the @storybookjs/core team.

core team members can create a new canary release here or locally with gh workflow run --repo storybookjs/storybook publish.yml --field pr=32799

coderabbitai · 2025-10-23T07:17:15Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch checklist-tasks

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

nx-cloud · 2025-10-23T07:21:49Z

View your CI Pipeline Execution ↗ for commit f0dfab7

Command	Status	Duration	Result
`nx run-many -t build --parallel=3`	✅ Succeeded	45s	View ↗

☁️ Nx Cloud last updated this comment at 2025-11-12 13:52:25 UTC

storybook-app-bot · 2025-10-23T07:30:09Z

Package Benchmarks

^{Commit: f0dfab7, ran on 12 November 2025 at 13:45:07 UTC}

The following packages have significant changes to their size or dependencies:

`@storybook/addon-a11y`

	Before	After	Difference
Dependency count	0	2	🚨 +2 🚨
Self size	0 B	509 KB	🚨 +509 KB 🚨
Dependency size	0 B	2.97 MB	🚨 +2.97 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/addon-docs`

	Before	After	Difference
Dependency count	0	18	🚨 +18 🚨
Self size	0 B	1.88 MB	🚨 +1.88 MB 🚨
Dependency size	0 B	10.21 MB	🚨 +10.21 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/addon-links`

	Before	After	Difference
Dependency count	0	1	🚨 +1 🚨
Self size	0 B	15 KB	🚨 +15 KB 🚨
Dependency size	0 B	5 KB	🚨 +5 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/addon-onboarding`

	Before	After	Difference
Dependency count	0	0	0
Self size	0 B	56 KB	🚨 +56 KB 🚨
Dependency size	0 B	670 B	🚨 +670 B 🚨
Bundle Size Analyzer	Link	Link

`storybook-addon-pseudo-states`

	Before	After	Difference
Dependency count	0	0	0
Self size	0 B	24 KB	🚨 +24 KB 🚨
Dependency size	0 B	689 B	🚨 +689 B 🚨
Bundle Size Analyzer	Link	Link

`@storybook/addon-themes`

	Before	After	Difference
Dependency count	0	1	🚨 +1 🚨
Self size	0 B	20 KB	🚨 +20 KB 🚨
Dependency size	0 B	28 KB	🚨 +28 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/addon-vitest`

	Before	After	Difference
Dependency count	0	6	🚨 +6 🚨
Self size	0 B	509 KB	🚨 +509 KB 🚨
Dependency size	0 B	1.53 MB	🚨 +1.53 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/builder-vite`

	Before	After	Difference
Dependency count	0	11	🚨 +11 🚨
Self size	0 B	330 KB	🚨 +330 KB 🚨
Dependency size	0 B	1.30 MB	🚨 +1.30 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/builder-webpack5`

	Before	After	Difference
Dependency count	0	187	🚨 +187 🚨
Self size	0 B	73 KB	🚨 +73 KB 🚨
Dependency size	0 B	31.88 MB	🚨 +31.88 MB 🚨
Bundle Size Analyzer	Link	Link

`storybook`

	Before	After	Difference
Dependency count	0	43	🚨 +43 🚨
Self size	0 B	24.88 MB	🚨 +24.88 MB 🚨
Dependency size	0 B	17.36 MB	🚨 +17.36 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/angular`

	Before	After	Difference
Dependency count	0	187	🚨 +187 🚨
Self size	0 B	126 KB	🚨 +126 KB 🚨
Dependency size	0 B	30.02 MB	🚨 +30.02 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/ember`

	Before	After	Difference
Dependency count	0	191	🚨 +191 🚨
Self size	0 B	17 KB	🚨 +17 KB 🚨
Dependency size	0 B	28.60 MB	🚨 +28.60 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/html-vite`

	Before	After	Difference
Dependency count	0	14	🚨 +14 🚨
Self size	0 B	23 KB	🚨 +23 KB 🚨
Dependency size	0 B	1.67 MB	🚨 +1.67 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/nextjs`

	Before	After	Difference
Dependency count	0	533	🚨 +533 🚨
Self size	0 B	749 KB	🚨 +749 KB 🚨
Dependency size	0 B	58.93 MB	🚨 +58.93 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/nextjs-vite`

	Before	After	Difference
Dependency count	0	124	🚨 +124 🚨
Self size	0 B	3.83 MB	🚨 +3.83 MB 🚨
Dependency size	0 B	21.87 MB	🚨 +21.87 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/preact-vite`

	Before	After	Difference
Dependency count	0	14	🚨 +14 🚨
Self size	0 B	14 KB	🚨 +14 KB 🚨
Dependency size	0 B	1.65 MB	🚨 +1.65 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/react-native-web-vite`

	Before	After	Difference
Dependency count	0	157	🚨 +157 🚨
Self size	0 B	31 KB	🚨 +31 KB 🚨
Dependency size	0 B	23.11 MB	🚨 +23.11 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/react-vite`

	Before	After	Difference
Dependency count	0	114	🚨 +114 🚨
Self size	0 B	37 KB	🚨 +37 KB 🚨
Dependency size	0 B	19.66 MB	🚨 +19.66 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/react-webpack5`

	Before	After	Difference
Dependency count	0	273	🚨 +273 🚨
Self size	0 B	25 KB	🚨 +25 KB 🚨
Dependency size	0 B	43.89 MB	🚨 +43.89 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/server-webpack5`

	Before	After	Difference
Dependency count	0	199	🚨 +199 🚨
Self size	0 B	17 KB	🚨 +17 KB 🚨
Dependency size	0 B	33.14 MB	🚨 +33.14 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/svelte-vite`

	Before	After	Difference
Dependency count	0	19	🚨 +19 🚨
Self size	0 B	59 KB	🚨 +59 KB 🚨
Dependency size	0 B	26.79 MB	🚨 +26.79 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/sveltekit`

	Before	After	Difference
Dependency count	0	20	🚨 +20 🚨
Self size	0 B	58 KB	🚨 +58 KB 🚨
Dependency size	0 B	26.85 MB	🚨 +26.85 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/vue3-vite`

	Before	After	Difference
Dependency count	0	109	🚨 +109 🚨
Self size	0 B	38 KB	🚨 +38 KB 🚨
Dependency size	0 B	43.95 MB	🚨 +43.95 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/web-components-vite`

	Before	After	Difference
Dependency count	0	15	🚨 +15 🚨
Self size	0 B	20 KB	🚨 +20 KB 🚨
Dependency size	0 B	1.70 MB	🚨 +1.70 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/cli`

	Before	After	Difference
Dependency count	0	187	🚨 +187 🚨
Self size	0 B	928 KB	🚨 +928 KB 🚨
Dependency size	0 B	74.82 MB	🚨 +74.82 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/codemod`

	Before	After	Difference
Dependency count	0	169	🚨 +169 🚨
Self size	0 B	35 KB	🚨 +35 KB 🚨
Dependency size	0 B	71.25 MB	🚨 +71.25 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/core-webpack`

	Before	After	Difference
Dependency count	0	1	🚨 +1 🚨
Self size	0 B	12 KB	🚨 +12 KB 🚨
Dependency size	0 B	28 KB	🚨 +28 KB 🚨
Bundle Size Analyzer	Link	Link

`create-storybook`

	Before	After	Difference
Dependency count	0	44	🚨 +44 🚨
Self size	0 B	1.55 MB	🚨 +1.55 MB 🚨
Dependency size	0 B	42.24 MB	🚨 +42.24 MB 🚨
Bundle Size Analyzer	node	node

`@storybook/csf-plugin`

	Before	After	Difference
Dependency count	0	9	🚨 +9 🚨
Self size	0 B	9 KB	🚨 +9 KB 🚨
Dependency size	0 B	1.27 MB	🚨 +1.27 MB 🚨
Bundle Size Analyzer	Link	Link

`eslint-plugin-storybook`

	Before	After	Difference
Dependency count	0	35	🚨 +35 🚨
Self size	0 B	139 KB	🚨 +139 KB 🚨
Dependency size	0 B	3.15 MB	🚨 +3.15 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/react-dom-shim`

	Before	After	Difference
Dependency count	0	0	0
Self size	0 B	22 KB	🚨 +22 KB 🚨
Dependency size	0 B	788 B	🚨 +788 B 🚨
Bundle Size Analyzer	Link	Link

`@storybook/preset-create-react-app`

	Before	After	Difference
Dependency count	0	68	🚨 +68 🚨
Self size	0 B	36 KB	🚨 +36 KB 🚨
Dependency size	0 B	5.98 MB	🚨 +5.98 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/preset-react-webpack`

	Before	After	Difference
Dependency count	0	170	🚨 +170 🚨
Self size	0 B	21 KB	🚨 +21 KB 🚨
Dependency size	0 B	31.20 MB	🚨 +31.20 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/preset-server-webpack`

	Before	After	Difference
Dependency count	0	10	🚨 +10 🚨
Self size	0 B	8 KB	🚨 +8 KB 🚨
Dependency size	0 B	1.20 MB	🚨 +1.20 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/html`

	Before	After	Difference
Dependency count	0	2	🚨 +2 🚨
Self size	0 B	30 KB	🚨 +30 KB 🚨
Dependency size	0 B	32 KB	🚨 +32 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/preact`

	Before	After	Difference
Dependency count	0	2	🚨 +2 🚨
Self size	0 B	17 KB	🚨 +17 KB 🚨
Dependency size	0 B	32 KB	🚨 +32 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/react`

	Before	After	Difference
Dependency count	0	57	🚨 +57 🚨
Self size	0 B	829 KB	🚨 +829 KB 🚨
Dependency size	0 B	12.92 MB	🚨 +12.92 MB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/server`

	Before	After	Difference
Dependency count	0	3	🚨 +3 🚨
Self size	0 B	9 KB	🚨 +9 KB 🚨
Dependency size	0 B	716 KB	🚨 +716 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/svelte`

	Before	After	Difference
Dependency count	0	2	🚨 +2 🚨
Self size	0 B	48 KB	🚨 +48 KB 🚨
Dependency size	0 B	230 KB	🚨 +230 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/vue3`

	Before	After	Difference
Dependency count	0	3	🚨 +3 🚨
Self size	0 B	61 KB	🚨 +61 KB 🚨
Dependency size	0 B	211 KB	🚨 +211 KB 🚨
Bundle Size Analyzer	Link	Link

`@storybook/web-components`

	Before	After	Difference
Dependency count	0	3	🚨 +3 🚨
Self size	0 B	43 KB	🚨 +43 KB 🚨
Dependency size	0 B	47 KB	🚨 +47 KB 🚨
Bundle Size Analyzer	Link	Link

storybook-bot · 2025-11-04T11:08:00Z

Failed to publish canary version of this pull request, triggered by @kasperpeulen. See the failed workflow run at: https://github.com/storybookjs/storybook/actions/runs/19066601453

storybook-bot · 2025-11-04T11:10:28Z

Failed to publish canary version of this pull request, triggered by @kasperpeulen. See the failed workflow run at: https://github.com/storybookjs/storybook/actions/runs/19066665012

…first task for each section rather than first 3 open tasks

…lar set of (known) tasks

…pleted

… completed

…t to subscribe function since it will not receive updates there

…ow actions

…Guide, remove unused Button and GuidedTour components, and update onboarding logic for improved user experience.

ghengeveld requested review from kylegach and valentinpalkovic October 23, 2025 07:16

ghengeveld self-assigned this Oct 23, 2025

ghengeveld added feature request ci:normal labels Oct 23, 2025

ghengeveld changed the base branch from next to onboarding-checklist October 23, 2025 07:16

This was referenced Oct 23, 2025

Core: Onboarding checklist #32795

Open

Core: Onboarding guide #32874

Open

ghengeveld force-pushed the checklist-tasks branch 5 times, most recently from 9e334b3 to 090a9f8 Compare October 31, 2025 14:52

ghengeveld added 12 commits November 4, 2025 20:34

Rename 'Guided tour' to 'Guide'

f473e21

Add support for task dependencies and update ChecklistModule to show …

69cc7ba

…first task for each section rather than first 3 open tasks

Change ChecklistModule based on progress

ce5ebc0

Support custom action button label

4cd3631

Allow muting the ChecklistModule, either permanently or for a particu…

bd55f1e

…lar set of (known) tasks

Change selection of items in the ChecklistModule

c89bce5

Tweak spacing for visual consistency

02c9aca

Make ChecklistModule collapsible and fix card shadow styling

d685d12

Split Card 'All' story into separate stories

489113d

Drop superfluous initialCollapsed arg for Collapsible

e23d3f9

Hide ChecklistModule in prod mode

b7e60c5

Support providing useCollapsible state to Collapsible

46081e5

ghengeveld added 8 commits November 4, 2025 20:38

Update checklist criteria and checks

94c5c62

Persist autocompleted items in node_modules/.cache and add telemetry

5f1bd57

Support conditional guide items

5ba33eb

Use simpler navigation API

9d28bb0

Add guided tour and intent survey to checklist

cd97967

Show completion message instead of mute toggle when all tasks are com…

10917ad

…pleted

Prevent onboarding from returning to splash screen

589f1f0

Fix build command

624bfc6

ghengeveld force-pushed the checklist-tasks branch from e72c6b2 to 624bfc6 Compare November 4, 2025 19:39

ghengeveld added 21 commits November 4, 2025 23:05

Prevent guided tour from showing intent survey if it has already been…

5845f57

… completed

Ensure subscription callback is a function

1411869

Revert back to using ReactDOM.render

70914fe

Completion detection for install-vitest and run-tests tasks

af5996a

Don't skip checklist tasks when closing tour tooltip

571eb37

Better looking code blocks

da9c7b8

Fix mocks

8a27b33

Add items for installing dependencies

2adfb83

Use createRoot rather than deprecated ReactDOM.render

870ab94

Fix testing widget overflow to allow highlighting for onboarding

d6e6f09

Reduce update frequency by throttling index updates

85b9fa1

Pass index to available function to receive updates, and don't pass i…

8c5c660

…t to subscribe function since it will not receive updates there

Make content a function

02917c4

Ignore example stories where appropriate

073778c

Prevent clicking on underlying collapse toggle when using checklist r…

bc7ac39

…ow actions

Fix addon identifier

9aef937

Rename Tour to TourGuide and make it a generic component

e311a22

Make renderTourGuide a static method on the TourGuide component

1f79889

Fix GuidePage sidebar toggle

1c8bb66

Refactor onboarding components: consolidate HighlightElement and Tour…

056a80f

…Guide, remove unused Button and GuidedTour components, and update onboarding logic for improved user experience.

Refactor useChecklist to provide all data needed in Checklist component

f0dfab7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Core: Define checklist tasks #32799

Core: Define checklist tasks #32799

ghengeveld commented Oct 23, 2025 •

edited by storybook-bot

Loading

Uh oh!

coderabbitai bot commented Oct 23, 2025

Review skipped

Uh oh!

nx-cloud bot commented Oct 23, 2025 •

edited

Loading

Uh oh!

storybook-app-bot bot commented Oct 23, 2025 •

edited

Loading

Uh oh!

storybook-bot commented Nov 4, 2025

Uh oh!

storybook-bot commented Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Core: Define checklist tasks #32799

Are you sure you want to change the base?

Core: Define checklist tasks #32799

Conversation

ghengeveld commented Oct 23, 2025 • edited by storybook-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

Manual testing

Documentation

Checklist for Maintainers

🦋 Canary release

Uh oh!

coderabbitai bot commented Oct 23, 2025

Review skipped

Uh oh!

nx-cloud bot commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

storybook-app-bot bot commented Oct 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Package Benchmarks

@storybook/addon-a11y

@storybook/addon-docs

@storybook/addon-links

@storybook/addon-onboarding

storybook-addon-pseudo-states

@storybook/addon-themes

@storybook/addon-vitest

@storybook/builder-vite

@storybook/builder-webpack5

storybook

@storybook/angular

@storybook/ember

@storybook/html-vite

@storybook/nextjs

@storybook/nextjs-vite

@storybook/preact-vite

@storybook/react-native-web-vite

@storybook/react-vite

@storybook/react-webpack5

@storybook/server-webpack5

@storybook/svelte-vite

@storybook/sveltekit

@storybook/vue3-vite

@storybook/web-components-vite

@storybook/cli

@storybook/codemod

@storybook/core-webpack

create-storybook

@storybook/csf-plugin

eslint-plugin-storybook

@storybook/react-dom-shim

@storybook/preset-create-react-app

@storybook/preset-react-webpack

@storybook/preset-server-webpack

@storybook/html

@storybook/preact

@storybook/react

@storybook/server

@storybook/svelte

@storybook/vue3

@storybook/web-components

Uh oh!

storybook-bot commented Nov 4, 2025

Uh oh!

storybook-bot commented Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ghengeveld commented Oct 23, 2025 •

edited by storybook-bot

Loading

nx-cloud bot commented Oct 23, 2025 •

edited

Loading

storybook-app-bot bot commented Oct 23, 2025 •

edited

Loading

`@storybook/addon-a11y`

`@storybook/addon-docs`

`@storybook/addon-links`

`@storybook/addon-onboarding`

`storybook-addon-pseudo-states`

`@storybook/addon-themes`

`@storybook/addon-vitest`

`@storybook/builder-vite`

`@storybook/builder-webpack5`

`storybook`

`@storybook/angular`

`@storybook/ember`

`@storybook/html-vite`

`@storybook/nextjs`

`@storybook/nextjs-vite`

`@storybook/preact-vite`

`@storybook/react-native-web-vite`

`@storybook/react-vite`

`@storybook/react-webpack5`

`@storybook/server-webpack5`

`@storybook/svelte-vite`

`@storybook/sveltekit`

`@storybook/vue3-vite`

`@storybook/web-components-vite`

`@storybook/cli`

`@storybook/codemod`

`@storybook/core-webpack`

`create-storybook`

`@storybook/csf-plugin`

`eslint-plugin-storybook`

`@storybook/react-dom-shim`

`@storybook/preset-create-react-app`

`@storybook/preset-react-webpack`

`@storybook/preset-server-webpack`

`@storybook/html`

`@storybook/preact`

`@storybook/react`

`@storybook/server`

`@storybook/svelte`

`@storybook/vue3`

`@storybook/web-components`