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

Add API docs to Storybook #102

Closed
fredvisser opened this issue Sep 7, 2021 · 3 comments
Closed

Add API docs to Storybook #102

fredvisser opened this issue Sep 7, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@fredvisser
Copy link
Contributor

fredvisser commented Sep 7, 2021

😯 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:

  • element name
  • property and attribute names (and how they map to each other if it's not obvious; see Storybook property name inconsistencies #824 ), types, and meaning
  • event names, event data types, and their meaning
  • method names, types of inputs and outputs, and their purpose
  • slots
  • accessibility concerns
  • first class support for all of the above in each of our frameworks, where member names often differ in capitalization or other ways

💁 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.

  1. We're currently using @storybook/html which doesn't support autogenerated API documentation, but it should be trivial to switch to @storybook/web-components which does.
  2. @storybook/web-components uses the custom-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.
@scotia673 scotia673 added blocked Blocked on a third-party issue enhancement New feature or request labels Oct 8, 2021
@m-akinc 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
@msmithNI
Copy link
Contributor

Duing the Innovation Day on 6/14/2023 I did some prototyping with TypeDoc for generating API docs from our TypeScript comments on nimble-components:
Storybook
branch

@jattasNI jattasNI mentioned this issue Jul 31, 2023
1 task
@m-akinc m-akinc removed the blocked Blocked on a third-party issue label Jun 5, 2024
@m-akinc
Copy link
Contributor

m-akinc commented Jun 5, 2024

It's not clear to me what this is blocked on, so I'm removing the label.

@jattasNI
Copy link
Contributor

jattasNI commented Jun 5, 2024

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.

@jattasNI jattasNI closed this as completed Jun 5, 2024
@jattasNI jattasNI self-assigned this Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

5 participants