Skip to content

Docs: Remove language from sh code snippets#34401

Merged
huang-julien merged 5 commits into
nextfrom
docs/code_snipper
May 4, 2026
Merged

Docs: Remove language from sh code snippets#34401
huang-julien merged 5 commits into
nextfrom
docs/code_snipper

Conversation

@huang-julien
Copy link
Copy Markdown
Contributor

@huang-julien huang-julien commented Mar 30, 2026

Closes #

What I did

Small fix for documentations. <CodeSnippets> automatically set the language to bash when packageManager is set

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

  • Visually check docs for modified code snippets

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
    • Standardized code-fence metadata for multiple installation and migration snippets so shell commands display correctly across package manager examples.
    • Reformatted documentation version metadata file to be human-readable (pretty-printed) without changing its content.

@huang-julien huang-julien self-assigned this Mar 30, 2026
@huang-julien huang-julien added the ci:docs Run the CI jobs for documentation checks only. label Mar 30, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 30, 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: 04815546-8159-4b08-8605-ef26958a067e

📥 Commits

Reviewing files that changed from the base of the PR and between 128895b and 64c3af2.

📒 Files selected for processing (1)
  • docs/versions/next.json
✅ Files skipped from review due to trivial changes (1)
  • docs/versions/next.json

📝 Walkthrough

Walkthrough

Removed language="js" attributes from shell/sh code-fence metadata across nine documentation snippet files; reformatted docs/versions/next.json from a single-line JSON to pretty-printed multi-line JSON. Command text and packageManager attributes in snippets remain unchanged.

Changes

Cohort / File(s) Summary
Documentation snippet formatting
docs/_snippets/addon-a11y-add.md, docs/_snippets/msw-addon-install.md, docs/_snippets/storybook-addon-compiler-babel-auto-install.md, docs/_snippets/storybook-addon-compiler-swc-auto-install.md, docs/_snippets/storybook-addon-run-dev-mode.md, docs/_snippets/storybook-migrate-csf-2-to-3.md, docs/_snippets/storybook-migrate-mdx-to-csf.md, docs/_snippets/storybook-migrate-stories-of-to-csf.md, docs/_snippets/test-runner-eject-config.md
Removed language="js" attribute from sh/shell code-fence metadata. Kept packageManager attributes and all command lines unchanged.
Docs version file formatting
docs/versions/next.json
Reformatted from a minified single-line JSON to a pretty-printed multi-line JSON object; preserved all field values and text content.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch docs/code_snipper

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.

Comment thread docs/_snippets/addon-a11y-add.md
@github-actions github-actions Bot added the Stale label Apr 14, 2026
kylegach added 2 commits May 1, 2026 11:17
* next: (719 commits)
  Bump version from 10.4.0-alpha.14 to 10.4.0-alpha.15 [skip ci]
  Write changelog for 10.4.0-alpha.15 [skip ci]
  move agent detection to config hook instead of configureVitest
  Bump version from 10.4.0-alpha.13 to 10.4.0-alpha.14 [skip ci]
  Write changelog for 10.4.0-alpha.14 [skip ci]
  Bump version from 10.4.0-alpha.12 to 10.4.0-alpha.13 [skip ci]
  Revert revert
  Write changelog for 10.4.0-alpha.13 [skip ci]
  fix tests
  revert
  fix steps collection
  fix formatting
  Use same icon for modified and related
  Replace icon for related changes
  always resolve telemetry state immediately
  add addon-mcp to internal UI Storybook
  await the call
  cleanup
  fix init telemetry being delayed
  Bump version from 10.4.0-alpha.11 to 10.4.0-alpha.12 [skip ci]
  ...
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 cleaning things up, @huang-julien!

@kylegach
Copy link
Copy Markdown
Contributor

kylegach commented May 1, 2026

FYI, I merged in latest next and pushed another commit to include all relevant snippet files.

@huang-julien huang-julien enabled auto-merge May 4, 2026 07:47
@huang-julien huang-julien disabled auto-merge May 4, 2026 08:55
@huang-julien huang-julien merged commit 3999e3c into next May 4, 2026
14 checks passed
@huang-julien huang-julien deleted the docs/code_snipper branch May 4, 2026 08:56
@github-actions github-actions Bot mentioned this pull request May 4, 2026
14 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 Stale

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants