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

[Docs] How can we improve our documentation? #1259

Closed
diogofscmariano opened this issue Mar 12, 2020 · 1 comment
Closed

[Docs] How can we improve our documentation? #1259

diogofscmariano opened this issue Mar 12, 2020 · 1 comment
Labels
❓ question Further information is requested
Milestone
2.0.0 Version

Comments

@diogofscmariano
Copy link
Contributor

diogofscmariano commented Mar 12, 2020 •
edited

We have three investigation paths we need to search about how can we improve our documentation:

  • read docgen from typescript definitions
  • invest effort in our addon and display the information we currently display
  • remove our addon and leverage docs addon

Timebox: 2 pax, 1 day
@diogofscmariano diogofscmariano added the ❓ question Further information is requested label Mar 12, 2020
@diogofscmariano diogofscmariano added this to the 2.0.0 Version milestone Mar 12, 2020
@nantunes nantunes self-assigned this Mar 16, 2020
@diogofscmariano diogofscmariano mentioned this issue Mar 23, 2020
Closed
@nantunes
Copy link
Collaborator

nantunes commented Mar 25, 2020 •
edited

Read docgen from typescript definitions: not possible (reactjs/react-docgen#33 / styleguidist/react-docgen-typescript#231).

We'll leverage the docs addon, so #1297 was created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
❓ question Further information is requested
Projects
None yet
Milestone
2.0.0 Version
Development

No branches or pull requests
2 participants
@nantunes @diogofscmariano