Comprehensive API Documentation

[echenley]

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]

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

[echenley]

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]

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

[jerefrer]

👍 Nice to see some docs, thanks !

[tomchentw]

ESDoc looks promising

[tomchentw]

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