Docs: Adds commands to the documentation#25589
Conversation
jonniebigodes
added
documentation
ci:docs
| ## Automatic installation | ||
|
|
||
| With the exception of preset addons, all addons have the same installation process: install and register. | ||
| Storybook includes a [`storybook add`](../api/cli-options.md#add) command to automate the setup of addons. Several community-led addons can be added using this command, except for preset addons. We encourage you to read the addon's documentation to learn more about its installation process. |
There was a problem hiding this comment.
This is more of a feature comment/question than a documentation one.
except for preset addons
I didn't realize the add command had this limitation. How do we expect users to know the difference? Is this a short-term limitation?
There was a problem hiding this comment.
Why can’t it handle preset style addons?
There was a problem hiding this comment.
If there are any addons where add fails, we should figure out what’s going on and fix the issue
There was a problem hiding this comment.
Why can’t it handle preset style addons?
I was just going on what was documented here. If that limitation isn't factual, that's great!
There was a problem hiding this comment.
So that we're all on the same page here, this isn't on us. Our presets are working; what I've encountered during my rounds collecting community addons is basically this, I've run into situations where preset addons failed to register. I cannot know for sure what's causing it, could be an outdated version or something of that nature. Hence why I left it as such so that we don't run into any situations where a user faces a similar question, reach out to us raising an issue/ discussion when the situation is out of our control.
There was a problem hiding this comment.
Could you please share a scenario where you had this failure? Thanks!
JReinhold
left a comment
JReinhold
left a comment
There was a problem hiding this comment.
Looks good overall but some information is slightly incorrect.
|
|
||
| ### `info` | ||
|
|
||
| Reports useful debugging information about your environment. Helpful in providing information when opening an issue or a discussion. |
There was a problem hiding this comment.
would it make sense to mention Github here? or even a link to the repo?
|
|
||
| <Callout variant="info"> | ||
|
|
||
| The `framework-filter` argument is optional and can filter the list of available frameworks. For example, `storybook sandbox react` will only show React-based sandboxes. |
There was a problem hiding this comment.
| The `framework-filter` argument is optional and can filter the list of available frameworks. For example, `storybook sandbox react` will only show React-based sandboxes. | |
| The `framework-filter` argument is optional and can filter the list of available frameworks. For example, `storybook sandbox` will prompt you with a list of all available sandboxes, where `storybook sandbox react` will only show React-based sandboxes. |
There was a problem hiding this comment.
This is just a placeholder, as the CLI options need to be accounted for the CLI versioning.
yannbf
left a comment
yannbf
left a comment
There was a problem hiding this comment.
This is looking great! Thank you so much for all this <3
5 participants
Partially addresses #21752 and follows up on #25538 and #22236
What I did
With this pull request the documentation was updated to feature some of the common commands used with Storybook (e.g.,
add,doctor).What was done:
doctorcommandaddcommand as the way users should install Storybook addons.@shilman and @yannbf, when both of you have a moment, can you take a look and follow up with me with the feedback you may have so that we can address it and get this merged in? One small item to put on your radar; if both of you are ok with it, I will push a pull request updating the remainder of the documentation to have the addons follow along with the
addcommand approach to help streamline the overall workflow and maintenance. We can talk a bit more about this async.Checklist for Contributors
Testing
docs_adds_doctor.The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
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/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 canary-release-pr.yml --field pr=<PR_NUMBER>