Skip to content
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

Merged
merged 8 commits into from
Jan 31, 2024
Merged

Docs: Re-document subcomponents #25800

merged 8 commits into from
Jan 31, 2024

Conversation

kylegach
Copy link
Contributor

Closes #20782

What I did

Checklist for Contributors

Testing

Manual testing

  1. Follow the steps in the contributing instructions for this branch, docs-sub-components
  2. Navigate to the writing-stories/stories-for-multiple-components and writing-docs/autodocs routes
  3. Confirm content is correct

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/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>

@kylegach kylegach added documentation ci:docs Run the CI jobs for documentation checks only. labels Jan 29, 2024
@kylegach kylegach self-assigned this Jan 29, 2024
@kylegach kylegach requested a review from JReinhold January 29, 2024 21:10
Copy link
Contributor

@JReinhold JReinhold left a 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.

docs/snippets/angular/list-story-with-subcomponents.ts.mdx Outdated Show resolved Hide resolved
docs/snippets/angular/list-story-with-subcomponents.ts.mdx Outdated Show resolved Hide resolved
docs/writing-docs/autodocs.md Outdated Show resolved Hide resolved
docs/writing-stories/stories-for-multiple-components.md Outdated Show resolved Hide resolved
Copy link
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.

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.


<!-- prettier-ignore-end -->

![Subcomponents in ArgTypes doc block](./doc-block-arg-types-subcomponents.png)
Copy link
Contributor

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Copy link
Contributor Author

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.

Copy link
Contributor

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.

@kylegach kylegach force-pushed the docs-sub-components branch from 539c37f to de25f2e Compare January 30, 2024 17:15
@kylegach
Copy link
Contributor Author

@jonniebigodes — Ready for your re-review when you're able!

@jonniebigodes
Copy link
Contributor

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.

@kylegach kylegach merged commit b34c5dd into next Jan 31, 2024
18 checks passed
@kylegach kylegach deleted the docs-sub-components branch January 31, 2024 17:07
@github-actions github-actions bot mentioned this pull request Jan 31, 2024
14 tasks
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.

[Feature Request]: Subcomponents support
3 participants