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

Addon-Onboarding: Fix snippet for Button stories #27026

Open
wants to merge 5 commits into
base: next
Choose a base branch
from

Conversation

Adriangar99
Copy link

@Adriangar99 Adriangar99 commented May 4, 2024

What I did

Changes a multiple errors in the typescript code snippets of the onboarding addon.

NOTE: The image 03-args.png in onboarding addon should be changed to reflejate the changes in the code snippet.

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!

  1. Using storybook in a Typescript project
  2. Open the onboarding in a storybook adding to the args of the url: onboarding=true
  3. Follow the steps of the onboarding until yo are in the step showing the code to generate the stories of the Button
  4. The showed code not contains errors if used in a real Typescript project

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>

@Adriangar99 Adriangar99 changed the title fix: change background to backgroundColor and add typeof in StoryObj in onboarding addon fix: change background to backgroundColor and add typeof in StoryObj in onboarding addon code snippets May 4, 2024
@yannbf yannbf self-assigned this May 6, 2024
@yannbf yannbf changed the title fix: change background to backgroundColor and add typeof in StoryObj in onboarding addon code snippets Addon-Onboarding: Fix snippet for Button stories May 6, 2024
Copy link

nx-cloud bot commented May 6, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit e91acff. 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.

@yannbf
Copy link
Member

yannbf commented May 6, 2024

Hey @Adriangar99 great catch! @cdedreuille ping regarding the image changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants