You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
run storybook and look at the generated autodocs for it. Note that the component description is not present.
Expected behavior
The same markdown documentation used for the officially recommended method of documenting a component should also be provided to the autodocs for any svelte stories.
Screenshots and/or logs
Example of the commented documentation working within VSCode:
Example of the autodoc-generated documentation not containing that same information:
Environment
OS: Mac OS
Node.js version: v20.5.0
NPM version: 9.8.0
Browser (if applicable): N/A
Browser version (if applicable): N/A
Device (if applicable): N/A
Additional context
This issue, along with storybookjs/addon-svelte-csf#122 would go a long way towards improving the storybook docs experience for Svelte.
The text was updated successfully, but these errors were encountered:
@Masstronaut I've transferred this issue from the storybookjs/addon-svelte-csf to the main storybook repo, since I believe this is unrelated to the addon but a feature in the Storybook renderer itself that is missing.
Describe the bug
Following the official svelte component documentation guidelines doesn't result in the autodocs generated page having documentation for the component.
Steps to reproduce the behavior
Expected behavior
The same markdown documentation used for the officially recommended method of documenting a component should also be provided to the autodocs for any svelte stories.
Screenshots and/or logs
Example of the commented documentation working within VSCode:
Example of the autodoc-generated documentation not containing that same information:
Environment
Additional context
This issue, along with storybookjs/addon-svelte-csf#122 would go a long way towards improving the storybook docs experience for Svelte.
The text was updated successfully, but these errors were encountered: