Skip to content

[Bug]: CSF-factories do not extract description comment above meta definition #36315

Description

@bodograumann

Describe the bug

In CSF3 it was possible to add a block comment above the definition of meta, which would be rendered as a description on the docs page. After the migration to CSF factories these comments are now ignored.

Reproduction link

https://stackblitz.com/edit/github-pfrjsytj?file=src%2Fstories%2FHeader.stories.ts

Reproduction steps

  1. Go to the above link
  2. Button docs page has a description
  3. Header docs page does not

System

Storybook Environment Info:


System:
OS: Linux 7.2 Arch Linux
CPU: (20) x64 12th Gen Intel(R) Core(TM) i7-12700H
Shell: 5.9.2 - /usr/bin/zsh
Binaries:
Node: 26.8.2 - /home/bodo/.local/share/mise/shims/node
Yarn: 1.22.22 - /usr/bin/yarn
npm: 12.0.2 - /home/bodo/.local/share/mise/shims/npm <----- active
pnpm: 11.26.0 - /usr/bin/pnpm
Browsers:
Firefox: 155.0.1
npmPackages:
@storybook/addon-designs: ^11.0.1 => 11.1.4
@storybook/addon-docs: ^10.0.5 => 10.6.0
@storybook/addon-vitest: ^10.0.5 => 10.6.0
@storybook/mdx2-csf: ^1.1.0 => 1.1.0
@storybook/vue3-vite: ^10.0.5 => 10.6.0
chromatic: ^18.0.0 => 18.8.0
eslint-plugin-storybook: ^10.0.5 => 10.6.0
storybook: ^10.0.5 => 10.6.0
npmGlobalPackages:
@storybook/cli: 8.1.4

Additional context

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions