Skip to content

Docs: fix documentation in contribute/code page#34727

Merged
kylegach merged 4 commits into
storybookjs:nextfrom
qadir1020:docs/fix-typo
May 11, 2026
Merged

Docs: fix documentation in contribute/code page#34727
kylegach merged 4 commits into
storybookjs:nextfrom
qadir1020:docs/fix-typo

Conversation

@qadir1020
Copy link
Copy Markdown

@qadir1020 qadir1020 commented May 6, 2026

Closes #

What I did

Three small grammar fixes in docs/contribute/code.mdx:

  • Line 105: commands acceptscommand accepts (subject-verb agreement)
  • Line 166: it's testing suiteits testing suite (possessive vs. contraction)
  • Line 170: lead to one of the maintainers marklead to one of the maintainers marking (gerund form needed)

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!

No manual testing is necessary. The change is text-only in docs/contribute/code.mdx. Reviewers can confirm by reading the diff in the "Files changed" tab.

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
    • Clarified contributor docs: fixed build command wording and added details on supported build arguments; expanded testing guidance to mention snapshot updates and that maintainers may mark PRs as Work in Progress.
    • Clarified "What’s a story?" guidance: explained that stories help verify UI correctness and highlighted checking related stories (e.g., Button variants) to avoid regressions.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9109e361-7c5e-46dc-aa2a-d342dae37eea

📥 Commits

Reviewing files that changed from the base of the PR and between bd44e1c and e9dd404.

📒 Files selected for processing (1)
  • docs/get-started/whats-a-story.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/get-started/whats-a-story.mdx

📝 Walkthrough

Walkthrough

Small documentation edits: clarify that yarn build accepts arguments, document re-running Vitest with -u for snapshot updates, note maintainers may mark PRs as Work in Progress if tests fail, and add a sentence about checking related Button stories for regressions.

Changes

Documentation Updates

Layer / File(s) Summary
Build arguments
docs/contribute/code.mdx
Adds sentence that the yarn build command accepts arguments to speed development.
Vitest snapshot guidance
docs/contribute/code.mdx
Explains rerunning tests with -u to update Vitest snapshots when they fail.
Work in Progress label
docs/contribute/code.mdx
Adds note that maintainers may mark PRs as Work in Progress until tests pass.
Story regression-checking
docs/get-started/whats-a-story.mdx
Inserts sentence directing readers to check the Button component’s other stories to verify changes to Primary don’t cause regressions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@qadir1020 qadir1020 changed the title docs: fix three grammar issues in contribute/code page docs: fix grammar in contribute/code page May 6, 2026
@qadir1020 qadir1020 changed the title docs: fix grammar in contribute/code page docs: fix documentation in contribute/code page May 6, 2026
@qadir1020 qadir1020 changed the title docs: fix documentation in contribute/code page Docs: fix documentation in contribute/code page May 6, 2026
@kylegach
Copy link
Copy Markdown
Contributor

kylegach commented May 8, 2026

Thanks, @qadir1020! Go ahead and throw the change from #34728 in here too and I'd be glad to approve & merge.

@kylegach kylegach self-assigned this May 8, 2026
@valentinpalkovic valentinpalkovic moved this to Empathy Queue (prioritized) in Core Team Projects May 11, 2026
@qadir1020
Copy link
Copy Markdown
Author

Thanks, @qadir1020! Go ahead and throw the change from #34728 in here too and I'd be glad to approve & merge.

Thanks @kylegach! I've pushed the change from #34728 into this PR — please take another look.

@qadir1020 qadir1020 mentioned this pull request May 11, 2026
8 tasks
Copy link
Copy Markdown
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 the fixes, @qadir1020!

@kylegach kylegach added the ci:docs Run the CI jobs for documentation checks only. label May 11, 2026
@kylegach kylegach merged commit 2d838f0 into storybookjs:next May 11, 2026
9 of 10 checks passed
@github-project-automation github-project-automation Bot moved this from Empathy Queue (prioritized) to Done in Core Team Projects May 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent-scan:human ci:docs Run the CI jobs for documentation checks only. documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants