Skip to content

Docs: fix incorrect onboarding addon information#34450

Open
GalacticAvenger wants to merge 1 commit intostorybookjs:nextfrom
GalacticAvenger:fix/onboarding-addon-docs
Open

Docs: fix incorrect onboarding addon information#34450
GalacticAvenger wants to merge 1 commit intostorybookjs:nextfrom
GalacticAvenger:fix/onboarding-addon-docs

Conversation

@GalacticAvenger
Copy link
Copy Markdown

@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
    • Updated onboarding addon setup instructions clarifying it is no longer included by default in new Storybook projects and must be manually installed and registered.
    • Clarified the manual process for triggering or retriggering the onboarding experience.
    • Updated documentation resource links to reflect the current location of onboarding addon materials.

- 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: a5f74b23-01d1-44e9-9ced-e58f668c5b18

📥 Commits

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

📒 Files selected for processing (2)
  • code/addons/onboarding/README.md
  • docs/configure/telemetry.mdx

📝 Walkthrough

Walkthrough

Documentation updates reflecting the onboarding addon's relocation and changed default inclusion status. The addon README instructions now specify manual installation and registration, while telemetry documentation updates its GitHub link reference to the new upstream path.

Changes

Cohort / File(s) Summary
Documentation Updates
code/addons/onboarding/README.md, docs/configure/telemetry.mdx
Updated onboarding addon instructions and GitHub link references to reflect the addon is no longer included by default and has relocated to the main Storybook repository. Changed triggering language from "automatic" to "manual navigation" in the README.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes


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
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: Empathy Queue (prioritized)

Development

Successfully merging this pull request may close these issues.

[Documentation]- Incorrect information about the onboarding addon

3 participants