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: Fix Subtitle block when no of prop passed #27147

Conversation

JReinhold
Copy link
Contributor

Closes #27139

What I did

#22552 introduced a regression, requiring the Subtitle doc block to have an of prop or be attached to stories. However none of this is strictly required, because children can also be passed to Subtitles.

This PR fixes that, supporting children without of or attachments.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

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>

@JReinhold JReinhold linked an issue May 15, 2024 that may be closed by this pull request
@JReinhold JReinhold added the bug label May 15, 2024
@JReinhold JReinhold requested a review from shilman May 15, 2024 09:31
@JReinhold JReinhold self-assigned this May 15, 2024
@JReinhold JReinhold added ci:normal patch:yes Bugfix & documentation PR that need to be picked to main branch labels May 15, 2024
Copy link

nx-cloud bot commented May 15, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit ccb9b5a. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@shilman shilman changed the title Docs: Fix Subtitle block throwing when no of prop passed Docs: Fix Subtitle block when no of prop passed May 15, 2024
@shilman shilman merged commit 1ba1a7e into next May 15, 2024
63 of 74 checks passed
@shilman shilman deleted the jeppe/27139-bug-unable-to-use-subtitle-doc-block-in-mdx-without-a-story branch May 15, 2024 09:55
storybook-bot pushed a commit that referenced this pull request May 15, 2024
…use-subtitle-doc-block-in-mdx-without-a-story

Docs: Fix Subtitle block when no `of` prop passed
(cherry picked from commit 1ba1a7e)
storybook-bot pushed a commit that referenced this pull request May 15, 2024
…use-subtitle-doc-block-in-mdx-without-a-story

Docs: Fix Subtitle block when no `of` prop passed
(cherry picked from commit 1ba1a7e)
@github-actions github-actions bot mentioned this pull request May 15, 2024
9 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs block: other bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Unable to Use Subtitle doc block in MDX without a Story
2 participants