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

Note Control's incompatibility with iframe stories in Docs mode #25593

Closed
wants to merge 1 commit into from

Conversation

kerryj89
Copy link

@kerryj89 kerryj89 commented Jan 13, 2024

I think this will save people some time when they are wondering why changing from inline to iframe doesn't work with controls in docs mode.

Closes #

What I did

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>

I think this will save people some time when they search for "iframe".
@jonniebigodes jonniebigodes self-assigned this Jan 15, 2024
@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. and removed patch:yes Bugfix & documentation PR that need to be picked to main branch labels Jan 15, 2024
Copy link
Contributor

@kylegach kylegach 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 this PR, @kerryj89!

We currently document this limitation here, https://storybook.js.org/docs/writing-docs/autodocs#the-controls-are-not-updating-the-story-within-the-auto-generated-documentation, but I agree it would be helpful to also add a callout on this page.

Can you please update this to:

  1. Be a similar heading under Troubleshooting on this page
  2. Link to the explanation on the other page

Thanks, and let me know if I can help.

@kylegach kylegach self-assigned this Jan 30, 2024
@jonniebigodes
Copy link
Contributor

@kerryj89, thank you for putting together this pull request and helping us improve the documentation. We appreciate it 🙏 ! However, the changes you're introducing were already added to a recent pull request. I hope you don't take it the wrong way, and I look forward to your next contribution.

Have a great day.

Stay safe.

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.

3 participants