Open Masstronaut opened 1 year ago
@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.
Afaik it's related to how sveldoc-parser extracts the documentation. The description should be before @component, not after.
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.