Skip to content

Docs: Add sidebarOnboardingChecklist feature and feature defaults#34103

Merged
ghengeveld merged 1 commit into
nextfrom
update-feature-docs
Mar 11, 2026
Merged

Docs: Add sidebarOnboardingChecklist feature and feature defaults#34103
ghengeveld merged 1 commit into
nextfrom
update-feature-docs

Conversation

@ghengeveld
Copy link
Copy Markdown
Member

@ghengeveld ghengeveld commented Mar 11, 2026

What I did

Added docs section for sidebarOnboardingChecklist feature config, and added default values for each feature (where a clear default exists).

Checklist for Contributors

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 PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

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

Summary by CodeRabbit

  • New Features

    • Added sidebarOnboardingChecklist optional boolean configuration option available across React, Angular, and non-renderer framework variants.
  • Documentation

    • Updated configuration API documentation with the new option.

@ghengeveld ghengeveld self-assigned this Mar 11, 2026
@ghengeveld ghengeveld added the ci:docs Run the CI jobs for documentation checks only. label Mar 11, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 11, 2026

📝 Walkthrough

Walkthrough

Documentation update adding a new optional sidebarOnboardingChecklist boolean configuration property to the main-config-features API reference across React, Angular, and non-renderer type definitions.

Changes

Cohort / File(s) Summary
Configuration Documentation
docs/api/main-config/main-config-features.mdx
Added sidebarOnboardingChecklist?: boolean property to three type definition blocks (React, Angular, and non-renderer variants) in the main configuration features documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs


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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/api/main-config/main-config-features.mdx (1)

232-238: Consider adding a documentation link for consistency.

Other feature descriptions include links to their respective documentation pages (e.g., [Actions](../../essentials/actions.mdx), [Viewport](../../essentials/viewport.mdx)). If documentation exists for the onboarding checklist, consider adding a link here for consistency.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/api/main-config/main-config-features.mdx` around lines 232 - 238, The
documentation for the feature `sidebarOnboardingChecklist` should include a link
to its specific docs page for consistency with other entries; update the
`sidebarOnboardingChecklist` section to reference the onboarding checklist
documentation (e.g., add a markdown link similar to `[Onboarding
Checklist](../../essentials/onboarding-checklist.mdx)` or the correct relative
path if different) while keeping the type/default text unchanged so the entry
matches the format used by `Actions` and `Viewport`.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/api/main-config/main-config-features.mdx`:
- Around line 232-238: The documentation for the feature
`sidebarOnboardingChecklist` should include a link to its specific docs page for
consistency with other entries; update the `sidebarOnboardingChecklist` section
to reference the onboarding checklist documentation (e.g., add a markdown link
similar to `[Onboarding Checklist](../../essentials/onboarding-checklist.mdx)`
or the correct relative path if different) while keeping the type/default text
unchanged so the entry matches the format used by `Actions` and `Viewport`.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 423d5cc3-af64-4434-8055-19820d476eea

📥 Commits

Reviewing files that changed from the base of the PR and between 63009c0 and 91ae7ce.

📒 Files selected for processing (1)
  • docs/api/main-config/main-config-features.mdx

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.

Appreciate you taking the time to put together this pull request and helping out with the docs. Appreciate it 🙏

All is good on my end. Merge when able

@ghengeveld ghengeveld merged commit c3424ab into next Mar 11, 2026
18 of 22 checks passed
@ghengeveld ghengeveld deleted the update-feature-docs branch March 11, 2026 15:13
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

None yet

Development

Successfully merging this pull request may close these issues.

2 participants