Skip to content

Docs: Adjust builder API snippet#33852

Merged
jonniebigodes merged 1 commit into
nextfrom
docs_fix_builder_snippet
Feb 16, 2026
Merged

Docs: Adjust builder API snippet#33852
jonniebigodes merged 1 commit into
nextfrom
docs_fix_builder_snippet

Conversation

@jonniebigodes
Copy link
Copy Markdown
Contributor

@jonniebigodes jonniebigodes commented Feb 16, 2026

Follows up on #33799

What I did

With this pull request, the Builder API example was updated to match the current state and associated pull request.

What was done:

  • Updated the snippet to match the current iteration and including missing APIs

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 docs-only pr, no manual testing required.

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
    • Updated Storybook builder API documentation to reflect interface improvements and enhanced server integration parameters.

@jonniebigodes jonniebigodes self-assigned this Feb 16, 2026
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Feb 16, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 16, 2026

📝 Walkthrough

Walkthrough

Documentation update to the Builder interface API snippet showing updated generic type parameters, reorganized method declarations, and modified method signatures for the Storybook builder API.

Changes

Cohort / File(s) Summary
Builder Interface Documentation
docs/_snippets/storybook-builder-api-interface.md
Updated Builder interface with new BuilderStats generic parameter constraint, added getConfig method, changed start parameter types (router: ServerApp, server: HttpServer), added new channel: ServerChannel parameter, and updated return types to use BuilderStats instead of Stats.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/_snippets/storybook-builder-api-interface.md (1)

1-23: Ensure Prettier formatting is applied.

As per coding guidelines, markdown files should be formatted using Prettier. Please run the formatter to ensure consistency with repository standards.

yarn prettier --write docs/_snippets/storybook-builder-api-interface.md

As per coding guidelines: Format code using Prettier with yarn prettier --write <file>

@jonniebigodes jonniebigodes merged commit 24db05a into next Feb 16, 2026
21 of 22 checks passed
@jonniebigodes jonniebigodes deleted the docs_fix_builder_snippet branch February 16, 2026 16:26
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.

1 participant