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: Correct addon-themes README to align text with code example #29548

Merged
merged 2 commits into from
Nov 6, 2024

Conversation

schallerala
Copy link
Contributor

@schallerala schallerala commented Nov 5, 2024

Closes #

none, fixing miss-alignment in documentation.

What I did

Align text block reference with below code.

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

  1. Using latest storybook and addon-themes (8.4.1)
  2. able to override the theme for a specific story, as the code was already presenting

Documentation

  • Add or update documentation reflecting your changes

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-storybook/src/sandbox-templates.ts
  • Make sure this PR contains one of the labels

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

Greptile Summary

Updates the README.md documentation for addon-themes to correct the parameter name for theme overrides from themes.themeOverride to globals.theme, ensuring consistency with code examples.

  • Fixed parameter name in /code/addons/themes/README.md to use globals.theme instead of themes.themeOverride
  • Documentation now correctly reflects both meta-level and story-level theme override syntax

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@jonniebigodes jonniebigodes self-assigned this Nov 6, 2024
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Nov 6, 2024
@jonniebigodes jonniebigodes changed the title documentation: Correct addon-themes README to align text with code example Docs: Correct addon-themes README to align text with code example Nov 6, 2024
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.

@schallerala thanks for taking the time to put together this pull request and helping us improve the documentation by catching this small typo. Appreciate it 🙏 !

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

Have a fantastic day.

Stay safe

Copy link

nx-cloud bot commented Nov 6, 2024

☁️ Nx Cloud Report

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

@jonniebigodes jonniebigodes merged commit ef38bb4 into storybookjs:next Nov 6, 2024
8 checks passed
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