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

Generate prop documentation #1109

Closed
1 task done
colebemis opened this issue Mar 4, 2021 · 1 comment
Closed
1 task done

Generate prop documentation #1109

colebemis opened this issue Mar 4, 2021 · 1 comment
Labels
docs Documentation typescript

Comments

@colebemis
Copy link
Contributor

colebemis commented Mar 4, 2021

Background

Now that all our components are written in TypeScript (🎉 ), let's use react-docgen-typescript to automatically generate prop documentation instead of manually keeping it up-to-date.

Note: We'll have to experiment with ways to document available system props and DOM props without cluttering the documentation.

Do this

  • Replace the hard-coded props tables on component documentation pages with prop documentation automatically generated by react-docgen-typescript

References

@colebemis colebemis mentioned this issue Mar 4, 2021
53 tasks
@colebemis colebemis added docs Documentation typescript labels Mar 4, 2021
@colebemis
Copy link
Contributor Author

Closed by #1323

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation typescript
Projects
None yet
Development

No branches or pull requests

1 participant