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

Automatically generate props documentation from types #73

Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Automatically generate props documentation from types #73

wants to merge 16 commits into from

Conversation

katamartin
Copy link
Member

@katamartin katamartin commented Jun 2, 2022 •
edited
Loading

This PR converts select component definitions to TypeScript, enabling the docs site to read in prop information automatically generated using react-docgen.

  • Introduces types incrementally by converting select component files to tsx
  • Adds new build-docs script
  • Reads generated component-props.json file in docs/ via new PropsTable component

@vercel
Copy link

vercel bot commented Jun 2, 2022 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments
Name Status Preview Updated
maps-demo ⬜️ Ignored (Inspect) Jun 17, 2022 at 10:27PM (UTC)
maps-docs ⬜️ Ignored (Inspect) Jun 17, 2022 at 10:27PM (UTC)

@katamartin katamartin marked this pull request as ready for review June 7, 2022 18:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@freeman-lab freeman-lab Awaiting requested review from freeman-lab

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@katamartin