-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Re-document subcomponents #25800
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, only a few minor suggestions you are free to do with what you want. there's quite a lot of links in snippet comments like https://storybook.js.org/docs/7.0/angular/... that looks off to me, but maybe they're correct.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for taking on this item; left some items for you to look into once you have a moment. I'll take another pass later on and if nothing arises approve it so that we can have it documented.
docs/writing-docs/autodocs.md
Outdated
|
||
<!-- prettier-ignore-end --> | ||
|
||
![Subcomponents in ArgTypes doc block](./doc-block-arg-types-subcomponents.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you confirm that this image is accurate? I suspect this was documented there as a placeholder and should be updated, as it was captured from a previous example and should instead align with the above example.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good eye! Looks like it's always been wrong. 😅
https://storybook.js.org/docs/6.5/writing-docs/docs-page#subcomponents-parameter
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I resolved this by simply re-using the List-based snippet and screenshot.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's go with it then.
Co-authored-by: Jeppe Reinhold <jeppe@chromatic.com>
- Update un-reverted snippets for v8
539c37f
to
de25f2e
Compare
@jonniebigodes — Ready for your re-review when you're able! |
Thanks for taking the time to put this pull request together. Appreciate it 🙏 ! I've checked, and it looks good on my end. Merge when able. |
Closes #20782
What I did
subcomponents
feature #21742Checklist for Contributors
Testing
Manual testing
docs-sub-components
writing-stories/stories-for-multiple-components
andwriting-docs/autodocs
routesDocumentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/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 canary-release-pr.yml --field pr=<PR_NUMBER>