Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] Can't set tags on <Meta> component to enable fine-grained autodocs #87

Closed
hallefsantos opened this issue Jan 4, 2023 · 6 comments · Fixed by #134
Closed

[Bug] Can't set tags on <Meta> component to enable fine-grained autodocs #87

hallefsantos opened this issue Jan 4, 2023 · 6 comments · Fixed by #134
Assignees
Labels
bug Something isn't working

Comments

@hallefsantos
Copy link

Hey guys, is there a way to use tags: ['autodocs'] to auto-generate documentation? Or is there a better way?

I've tried this, but didn't work.

image

Environment

System:
OS: Linux 5.10 Ubuntu 20.04.5 LTS (Focal Fossa)
CPU: (12) x64 AMD Ryzen 5 3600 6-Core Processor
Memory: 4.14 GB / 7.74 GB
Container: Yes
Shell: 5.8 - /bin/zsh
Binaries:
Node: 16.18.1 - ~/.nvm/versions/node/v16.18.1/bin/node
Yarn: 1.22.19 - ~/.nvm/versions/node/v16.18.1/bin/yarn
npm: 8.19.2 - ~/.nvm/versions/node/v16.18.1/bin/npm
npmPackages:
vite: 4.0.0 => 4.0.0

@hallefsantos hallefsantos added the bug Something isn't working label Jan 4, 2023
@hallefsantos hallefsantos changed the title [Question] [Question] Auto generate documentation Jan 4, 2023
@JReinhold JReinhold self-assigned this Jan 9, 2023
@JReinhold
Copy link
Collaborator

It should work the way you tried, but I'm not surprised that it doesn't, since this is a new prop to the top level meta definition.
Thanks for bringing this up!

In the mean time, the best workaround currently is to set autodocs globally, but that won't allow you specify it at the file level unfortunately.

https://storybook.js.org/docs/7.0/svelte/writing-docs/docs-page#configure

// .storybook/main.js

module.exports = {
  ...
  docs: {
    ...
    autodocs: true,
  },
};

@JReinhold
Copy link
Collaborator

@hallefsantos did it work natively as you expected? if not, then let's keep this open as a bug report to fix it.

@enyo
Copy link

enyo commented Apr 12, 2023

@JReinhold just ran into this and can confirm that setting auto docs on the Meta component does not work.

@viktorgullmark
Copy link

@JReinhold Same here, cant set tags on Meta

@JReinhold JReinhold reopened this Apr 27, 2023
@JReinhold JReinhold changed the title [Question] Auto generate documentation [Bug] Can't set tags on <Meta> component Apr 27, 2023
@JReinhold JReinhold changed the title [Bug] Can't set tags on <Meta> component [Bug] Can't set tags on <Meta> component to enable fine-grained autodocs Apr 27, 2023
@Masstronaut
Copy link

@JReinhold the workaround of setting autodocs globally worked for my use case. I do still think it's worth adding the missing fields to the Meta component though.

@j3rem1e
Copy link
Contributor

j3rem1e commented Sep 2, 2023

See #134

@benmccann benmccann linked a pull request Sep 14, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants