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

Comprehensive API Documentation #128

Closed
echenley opened this issue Oct 10, 2015 · 6 comments
Closed

Comprehensive API Documentation #128

echenley opened this issue Oct 10, 2015 · 6 comments

Comments

@echenley
Copy link

While it is possible to figure out how to use this library by reading the examples and other available code samples, anything beyond basic usage becomes a struggle due to lack of documentation. For instance, the fact that <InfoWindow /> can be nested inside <Marker /> is undocumented except for this unrelated example.

A list of props available for each component (including possible children) would go a long way to making this library viable for the majority of developers.

@tomchentw
Copy link
Owner

Certainly agree with this. Do you have any idea on good documentation tools?

tomchentw added a commit that referenced this issue Oct 13, 2015
* Added "Documentation" section. Ref #128
@echenley
Copy link
Author

The overview is looking good! 👍

Not super experienced with documentation myself, but this looks like an interesting project: https://github.com/reactjs/react-docgen. I ran it over the src/ directory but it doesn't understand that prop types are imported from another file. Am going to open an issue with them when I get the chance.

@echenley
Copy link
Author

Will see what they say: reactjs/react-docgen#33

@jerefrer
Copy link

👍 Nice to see some docs, thanks !

@tomchentw
Copy link
Owner

ESDoc looks promising

@tomchentw
Copy link
Owner

We're also looking for maintainers. Involve in #266 to help strengthen our community!

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

3 participants