Skip to content

Docs: Fix typos in writing tests documentation#33733

Merged
jonniebigodes merged 2 commits into
storybookjs:nextfrom
pavan-sh:docs/hyphenation-writing-tests
Feb 2, 2026
Merged

Docs: Fix typos in writing tests documentation#33733
jonniebigodes merged 2 commits into
storybookjs:nextfrom
pavan-sh:docs/hyphenation-writing-tests

Conversation

@pavan-sh
Copy link
Copy Markdown
Contributor

@pavan-sh pavan-sh commented Jan 31, 2026

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

Caution

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-storybook/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 publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

  • Documentation
    • Fixed hyphenation of compound adjectives in documentation for improved consistency and readability.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 31, 2026

📝 Walkthrough

Walkthrough

Minor documentation updates fixing hyphenation in compound adjectives within the writing-tests guide. Two instances of "real time" and one instance of "well established" are hyphenated to follow standard English grammar conventions.

Changes

Cohort / File(s) Summary
Documentation Grammar Fixes
docs/writing-tests/index.mdx
Corrected hyphenation in compound adjectives: "well-established" and "real-time" (2 occurrences).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@jonniebigodes jonniebigodes self-assigned this Feb 1, 2026
@jonniebigodes jonniebigodes changed the title Docs: hyphenate compound modifiers in writing-tests Docs: Fix typos in writing tests documentation Feb 2, 2026
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Feb 2, 2026
Copy link
Copy Markdown
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.

@pavan-sh, thanks for taking the time to put together this pull request and helping us improve the documentation by catching this minor typo. 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 jonniebigodes merged commit 37f7c49 into storybookjs:next Feb 2, 2026
10 of 11 checks passed
@github-actions github-actions Bot mentioned this pull request Feb 2, 2026
18 tasks
@pavan-sh
Copy link
Copy Markdown
Contributor Author

pavan-sh commented Feb 2, 2026

@pavan-sh, thanks for taking the time to put together this pull request and helping us improve the documentation by catching this minor typo. 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

Thanks, @jonniebigodes —really appreciate the review and the kind note. Happy to help, and have a great day!

@github-actions github-actions Bot mentioned this pull request Feb 3, 2026
18 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