Docs: Add sidebarOnboardingChecklist feature and feature defaults#34103
Conversation
📝 WalkthroughWalkthroughDocumentation update adding a new optional Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Comment |
There was a problem hiding this comment.
🧹 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
📒 Files selected for processing (1)
docs/api/main-config/main-config-features.mdx
jonniebigodes
left a comment
There was a problem hiding this comment.
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
What I did
Added docs section for
sidebarOnboardingChecklistfeature config, and added default values for each feature (where a clear default exists).Checklist for Contributors
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake 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/coreteam 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
sidebarOnboardingChecklistoptional boolean configuration option available across React, Angular, and non-renderer framework variants.Documentation