Component string Attribute Documentation Pattern

[jordanjones243]

Discussion

This issue comes from ensuring that all of the Auro component documentation on the docssite is accurate and consistent. There has been inconsistency around the way that attribute types have been documented on component API pages. The two scenarios I am seeing have to do with what appears under the attribute's type column (both of these example scenarios are from auro-button):

1. The word string is used under the type column

2. The acceptable values of the string attribute are listed out under the type column

I would like to propose meeting with the Auro team to determine a consistent pattern that we will apply to all components.

[jason-capsule42]

Type should be defining the type of value that get's applied to the prop/attr (e.g. String, Object, Array, Boolean, etc.). The list of valid values should be in the description.

[jordanjones243]

On top of what I wanted to discuss above, I also see inconsistencies on how we are documenting attributes/properties in the actual component. I am also seeing get methods being documented. If that is the way forward, all engineers need to be on the same page for how to document everything under the API table.

[jordanjones243]

Based on the discussion with the team, we determined that the proper way to document string properties/attributes with specific accepted values would be to document those under the type column. This follows documentation patterns from LitElement and makes it very clear to the user which strings are accepted for that property/attribute.

Getters will also be marked as private and not listed under API documentation.