Skip to content

Docs: Fix incorrect onboarding addon information#34450

Merged
valentinpalkovic merged 3 commits into
storybookjs:nextfrom
GalacticAvenger:fix/onboarding-addon-docs
May 28, 2026
Merged

Docs: Fix incorrect onboarding addon information#34450
valentinpalkovic merged 3 commits into
storybookjs:nextfrom
GalacticAvenger:fix/onboarding-addon-docs

Conversation

@GalacticAvenger
Copy link
Copy Markdown
Contributor

@GalacticAvenger GalacticAvenger commented Apr 2, 2026

Summary

Fixes incorrect documentation about the onboarding addon.

Fixes #32530

Changes

  1. code/addons/onboarding/README.md: Updated to reflect that the onboarding addon is no longer included by default in new Storybook projects. The previous text incorrectly stated "This addon comes installed by default."
  2. docs/configure/telemetry.mdx: Updated the "Storybook guided tour" link from the archived storybookjs/addon-onboarding repository to the current monorepo location at storybookjs/storybook/tree/next/code/addons/onboarding.

How to test

  • Verify the README accurately describes the current installation behavior
  • Verify the telemetry docs link points to the correct (non-archived) location

Summary by CodeRabbit

  • Documentation
    • Clarified onboarding addon setup: it's no longer included by default in new projects and must be installed and registered manually.
    • Clarified how to manually trigger or retrigger the onboarding experience.
    • Updated documentation links to point to the current location of onboarding resources.

Review Change Stack

- Update README to reflect that the onboarding addon is no longer
  included by default in new Storybook projects
- Update telemetry docs to link to the monorepo location instead
  of the archived addon-onboarding repository

Fixes storybookjs#32530
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 2, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4362e1bf-a08e-4fba-8720-91efbebe9ba0

📥 Commits

Reviewing files that changed from the base of the PR and between 3c1d16b and 4c1ab1a.

📒 Files selected for processing (1)
  • code/addons/onboarding/README.md

📝 Walkthrough

Walkthrough

Documentation updates: README now instructs installing/registering the onboarding addon and manually navigating to /?path=/onboarding; telemetry docs update a GitHub link target to the addon’s new location in the main Storybook repo.

Changes

Documentation Updates

Layer / File(s) Summary
Onboarding README and telemetry link
code/addons/onboarding/README.md, docs/configure/telemetry.mdx
Rewrites triggering instructions to remove default-inclusion claim, instructs installing/registering the addon and navigating to /?path=/onboarding; updates telemetry docs link to github.com/storybookjs/storybook/tree/next/code/addons/onboarding.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch fix/onboarding-addon-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@valentinpalkovic valentinpalkovic changed the title docs: fix incorrect onboarding addon information Docs: fix incorrect onboarding addon information Apr 7, 2026
@valentinpalkovic valentinpalkovic added documentation ci:docs Run the CI jobs for documentation checks only. labels Apr 7, 2026
@valentinpalkovic valentinpalkovic moved this to Empathy Queue (prioritized) in Core Team Projects Apr 7, 2026
Copy link
Copy Markdown
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GalacticAvenger thanks for taking the time to put together this pull request and helping us improve the documentation by catching these small issues. We appreciate it 🙏 ! I left one small item for you to look into when you're able.

Let me know once you've addressed it and I'll be more than glad to take another look and get it merged.

Have a fantastic day.

Stay safe

Comment thread code/addons/onboarding/README.md Outdated
Co-authored-by: jonniebigodes <joaocontadesenvolvimento@gmail.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 21, 2026

Fails
🚫 PR description is missing the mandatory "#### Manual testing" section. Please add it so that reviewers know how to manually test your changes.

Generated by 🚫 dangerJS against 9f7f001

@valentinpalkovic valentinpalkovic moved this from Empathy Queue (prioritized) to In Progress in Core Team Projects May 21, 2026
…docs

# Conflicts:
#	docs/configure/telemetry.mdx
@jonniebigodes jonniebigodes changed the title Docs: fix incorrect onboarding addon information Docs: Fix incorrect onboarding addon information May 21, 2026
@valentinpalkovic valentinpalkovic merged commit 0328c65 into storybookjs:next May 28, 2026
9 of 11 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in Core Team Projects May 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

[Documentation]- Incorrect information about the onboarding addon

3 participants