Feedback for /writing-docs/autodocs docs page

[storybook-bot]

👍	👎
5	12

[storybook-bot]

/docs/react/writing-docs/autodocs

👎	v7.0	react	ts

The first sample screenshot has a description for the component (Primary UI Component For User Interaction) that is not visible on the Button.stories file. Where is this description coming from? This is unclear to me.

[kylegach]

It's coming from a JSDoc comment on the component export. Details here: https://storybook.js.org/docs/react/api/doc-block-description#writing-descriptions

We could probably make this more clear on this page, though. 🤔

[jonniebigodes]

Currently tracked in #22012

[storybook-bot]

/docs/7.0/react/writing-docs/autodocs

👍	v7.0	react	ts

example

[storybook-bot]

/docs/7.0/react/writing-docs/autodocs

👍	v7.0	react	ts

[storybook-bot]

/docs/7.1/react/writing-docs/autodocs

👎	v7.1	react	ts

I see we can now generate a table of contents in autodocs. This is excellent and very useful. However, in some cases we have to create custom docs using MDX. Is there any way to use this feature in MDX? It doesn't appear to be available as a block in @storybook/blocks

[jonniebigodes]

Thanks for reaching out to us with your feedback, and glad that you find it useful. If you're writing documentation in MDX, you can enable the table of contents, and it will be generated based on your documentation structure and configuration. However, it goes without saying that currently, you cannot customize it. See here for more context on this limitation.

If you're interested in helping us improve it, let us know here in the monorepo or on our Discord Server.

Looking forward to hearing from you. Have a great day

[storybook-bot]

/docs/7.1/svelte/writing-docs/autodocs

👎	v7.1	svelte	ts

It is unclear how the annotations/descriptions for the stories of this image (https://storybook.js.org/28b2f00782649b7c2ad244ee333fb402/autodocs.png) were created.

[jonniebigodes]

Thanks for taking the time to reach out to us with your feedback. We appreciate it 🙏 ! To give you some context on this, the descriptions are being inferred automatically from the component's props/inputs and displayed in the documentation. We plan on expanding this a bit further and providing additional context. Currently being tracked here

[storybook-bot]

/docs/7.3/react/writing-docs/autodocs

👎	v7.3	react	ts

No npm scripts, no details on how to integrate into existing node project.

[kylegach]

Sorry, can you add more details? I'm not sure what you mean.

[storybook-bot]

/docs/7.3/react/writing-docs/autodocs

👎	v7.3	react	ts

No npm scripts, no details on how to integrate into existing node project.

[storybook-bot]

/docs/7.3/react/writing-docs/autodocs

👎	v7.3	react	ts

interface DocsContainerProps<TFramework extends Renderer$1 = Renderer$1> {
context: DocsContextProps;
theme?: ThemeVars;
}

in your text it's not updated

[kylegach]

Are you suggesting that the snippet here, https://storybook.js.org/docs/7.3/react/writing-docs/autodocs#customize-the-docs-container, should make it clear that context and theme are available props?

[storybook-bot]

/docs/7.4/angular/writing-docs/autodocs

👎	v7.4	angular	ts

The following does not work in Angular:

      page: () => (
        <>
          <Title />
          <Subtitle />
          <Description />
          <Primary />
          <Controls />
          <Stories />
        </>
      ),
    },

[storybook-bot]

/docs/7.4/react/writing-docs/autodocs

👎	v7.4	react	ts

It doesn't say where the props documentation is coming from

[storybook-bot]

/docs/7.5/react/writing-docs/autodocs

👎	v7.5	react	ts

Where does the autogenerated docs come from? What do I need to add to my component?

[storybook-bot]

/docs/7.5/web-components/writing-docs/autodocs

👍	v7.5	web-components	ts

[storybook-bot]

/docs/7.6/writing-docs/autodocs

👍	v7.6	react	ts

[storybook-bot]

/docs/7.6/writing-docs/autodocs

👍	v7.6	react	ts

[storybook-bot]

/docs/7.6/writing-docs/autodocs

👎	v7.6	angular	ts

The code example in Write a custom template is in React, even when viewing the Angular docs.

[storybook-bot]

/docs/8.0/writing-docs/autodocs

👎	v8.0	react	ts

Subcomponents is not working at all. I was hoping it would allow me to display the documentation from my view components doc comment, without having to duplicate the text in container component or story. In case you are not aware the common pattern of splitting react code into dumb view & smart container results in no documentation in storybook

[storybook-bot]

/docs/8.0/writing-docs/autodocs

👎	v8.0	react	ts

show code examples please