-
Notifications
You must be signed in to change notification settings - Fork 8
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
Add API docs to Storybook #102
Labels
documentation
Improvements or additions to documentation
Comments
scotia673
added
blocked
Blocked on a third-party issue
enhancement
New feature or request
labels
Oct 8, 2021
m-akinc
added
documentation
Improvements or additions to documentation
and removed
enhancement
New feature or request
labels
Jan 28, 2022
rajsite
pushed a commit
that referenced
this issue
Mar 15, 2022
1 task
It's not clear to me what this is blocked on, so I'm removing the label. |
I didn't realize this issue existed. I've been using #824 to track this work. The basics are done now and there's already a list of remaining items in that issue, so I'm going to close this one. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
😯 Problem to Solve
We would like to display great API documentation and maintain it in a low-effort way. This includes the entire API of a component, for example:
💁 Proposed Solution
Currently we maintain some of this manually in Storybook, but a lot of it is missing and there may be better ways to autogenerate it from source. Storybook supports several tools to extract this information from the component definition and pull it into Storybook.
@storybook/html
which doesn't support autogenerated API documentation, but it should be trivial to switch to@storybook/web-components
which does.@storybook/web-components
uses thecustom-elements-manifest
tool to extract API documentation from the component. It has support for FAST element, but doesn't yet have support for components defined on FAST foundation.The text was updated successfully, but these errors were encountered: