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

Add React Components documentation #31

Closed
rupav opened this issue Apr 26, 2018 · 2 comments
Closed

Add React Components documentation #31

rupav opened this issue Apr 26, 2018 · 2 comments

Comments

@rupav
Copy link
Collaborator

rupav commented Apr 26, 2018

Expected Behaviour

Currently, there are many components which make it difficult for a newcomer to parse through, having a documentation of such components will make it easy to know about the components. Hence, I will be using an open-source library to generate documentation of components: react-docgen.

This will be the modified docs directory then.

|-- docs
| ____ |-- Client
| ___________ |-- componentsDocs.json # generated documentation.
| ____ |-- source

@achillesrasquinha

@rupav
Copy link
Collaborator Author

rupav commented May 24, 2018

@achillesrasquinha @akram-mohammed your opinion on this?

@rupav
Copy link
Collaborator Author

rupav commented May 27, 2018

Will repoen in later stage of the programme. Not a priority now.

@rupav rupav closed this as completed May 27, 2018
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

No branches or pull requests

1 participant