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.

Sign up for GitHub

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

Jump to bottom

API docs for TypeScript packages #16

Open
russellmcc opened this issue Sep 7, 2024 · 1 comment
Open

API docs for TypeScript packages #16

russellmcc opened this issue Sep 7, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@russellmcc
Copy link
Owner

Right now we have no API docs for the TypeScript packages we expose, which is a pretty major documentation gap, and will become more of a problem as more TypeScript library code is added to the framework.

I think api-documenter might be the best path here, which could output markdown files to be consumed by the nextra docs site. Some customization would likely have to be done to get a good output, though.
@russellmcc russellmcc added the documentation Improvements or additions to documentation label Sep 16, 2024
@russellmcc
Copy link
Owner Author

A related approach is described here storybookjs/storybook#17646

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@russellmcc