updated list component docs

[merkoyep]

Background

• Updates List component docs primarily nested props like BadgeProps, SubtitleType, and Badge(s).

https://github.com/Shopify/ui-extensions/assets/81783308/8946d23a-a11f-4635-afcd-4e72f3037b5c

Solution

• Edited List.ts and Badge.ts to add descriptions to referenced Props.

• Added subsections with generic sections to the page for Guidelines and ContentGuidelines sections.

  🎩

• Visit THIS SPINSTANCE

• Compare it with the old docs.

• Read through the List component docs, ensuring you click through the sub-props that are commonly nested within the main props like data.

• Take note of formatting and layout.

• Anything else that is expected for component docs.

Checklist

• [x] I have :tophat:'d these changes
• [x] I have updated relevant documentation

[github-actions[bot]]

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

[js-goupil]

This looks great. I wonder if we could reuse the examples from the product search API docs as examples for how to use the List. Since it shows how to render the list with several of the properties

https://github.com/Shopify/ui-extensions/blob/3de41c6da64e60fdc9c4551987babdd9a12287d1/packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/product-search-api.doc.ts#L28-L39