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

refactor(gatsby-remark-api-table): Replace documentation with the use of react-docgen #2025

Merged

Conversation

matuzalemsteles
Copy link
Member

@matuzalemsteles matuzalemsteles commented May 27, 2019

WIP/Draft

This is experimental and the implementation is very simple yet, there are many improvements that we can implement in the API table experience.

I used react-docgen directly because it recently released a beta version with TypeScript support and gatsby-transformer-react-docgen is still with the old implementations.


See example: Date Picker API Table

@coveralls
Copy link

coveralls commented May 27, 2019

Pull Request Test Coverage Report for Build 2692

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 82.271%

Totals Coverage Status
Change from base Build 2687: 0.0%
Covered Lines: 1219
Relevant Lines: 1390

💛 - Coveralls

@bryceosterhaus
Copy link
Member

One thing I noticed is the type will often reference our interface's name, this seems like it might be unhelpful unless we can link to the definition of that interface. What do you think?

Screen Shot 2019-05-29 at 4 11 29 PM

@matuzalemsteles
Copy link
Member Author

@bryceosterhaus yeah, I thought to do that too, I think a great idea, react-docgen is implementing logic to get the imported reactjs/react-docgen#352 types, this can help us create this. We still have to think about how we are going to show the information of another type on the screen.

@matuzalemsteles matuzalemsteles changed the base branch from develop to master June 10, 2019 23:20
@matuzalemsteles
Copy link
Member Author

hey guys, I've made some improvements here to prepare for the alpha release. I'm merging this so we can gather feedback during this time.

Screen Shot 2019-06-11 at 16 35 58

@matuzalemsteles matuzalemsteles merged commit 1ab5b87 into liferay:master Jun 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants