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: update outdated guide to make code open by default #26872

Merged
merged 4 commits into from
May 14, 2024

Conversation

abiriadev
Copy link
Contributor

What I did

For storybook 7 or higher, the code below does not work.

export const parameters = {
  docs: {
    source: {
      state: 'open',
    },
  },
};

It should be fixed like below:

export const parameters = {
  docs: {
    canvas: {
      sourceState: 'shown'
    }
  }
};

However, this document seems not changed so far. So I updated it.

References:

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 is a document change, no testing is required.

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.

For storybook 7 or higher, the code below does not work.

```js
export const parameters = {
  docs: {
    source: {
      state: 'open',
    },
  },
};
```

It should be fixed like below:

```js
export const parameters = {
  docs: {
    canvas: {
      sourceState: 'shown'
    }
  }
};
```

However, this document seems not changed so far. So I updated it.

## References:

- https://storybook.js.org/docs/api/doc-block-canvas#sourcestate
- storybookjs#10430
@jonniebigodes jonniebigodes self-assigned this Apr 22, 2024
@jonniebigodes jonniebigodes added ci:docs Run the CI jobs for documentation checks only. documentation labels May 14, 2024
@jonniebigodes jonniebigodes changed the title docs: update outdated guide to make code open by default Docs: update outdated guide to make code open by default May 14, 2024
Copy link

nx-cloud bot commented May 14, 2024

☁️ Nx Cloud Report

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

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.

@abiriadev thanks for taking the time to put together this pull request and helping us improve the documentation with this small but important misconfiguration. We appreciate it 🙏 !

I've checked and all is good on my end. Going to merge this once the checklist clears.

Hope you have a great day.

Stay safe

@jonniebigodes
Copy link
Contributor

Self merging this.

@jonniebigodes jonniebigodes merged commit 78bbb6c into storybookjs:next May 14, 2024
9 of 10 checks passed
@github-actions github-actions bot mentioned this pull request May 14, 2024
17 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.

2 participants