Style Guide: Create a template for component README

[woocommerce]

Style Guide: Create a template for component README

[ryelle]

We have two basic approaches, example 1 and example 2

Both have:

• Component Name
• Short description of component
• Optional, reasoning for why the component exists/when to use, or any special requirements for use
• Example of how to use the component
• Details about the props

The biggest difference is in the props display. I think we should go with a table format after all, maybe something modeled after the react-docgen-markdown-renderer output, in the hopes we can use something like that eventually 🙂

Prop	Type	Required	Default	Description
title	string	*	(none)	The title of this section
options	object			Options for example rendering
options.count	number		2	A count of items for demo

[ryelle]

Now that we're generating docs from inline comments, we can close this. 🎉