ONSdigital / design-system

ONS Design System
https://service-manual.ons.gov.uk/design-system
MIT License
28 stars 17 forks source link

[Spike] Identify components without examples and/or macro options file #3158

Closed daniellecorke closed 1 month ago

daniellecorke commented 2 months ago

Background

Following a review of #2076, it was identified that several components do not have examples and/or macro options files.

The following components have already been identified as not including a _macro-options.md file:

However, due to the age of the previous ticket, we should check all components again.

Tasks

  1. Look at each component and list any that do not have an example and/or a macro options file.
  2. Raise further tickets to add examples and/or macro options files to these components.
rmccar commented 2 months ago

Check through DS and see if there are any examples for any macros that we should add, if there aren't any then this can be closed. The 4 above aren't ones that would be used on their own so we don't think they should be documented in that way.

SriHV commented 1 month ago

Based on the inputs from prev tech session,I have recorded components that might/ might not require an example so we can discuss in next tech session List of Components that have examples in Foundation:

  1. Address-output
  2. Icon
  3. List
  4. Quote

List of components that can have a example

  1. Modal
  2. Message
  3. Message list
SriHV commented 1 month ago

Based on conversations from tech session, I will create a new ticket to to move the list examples from foundation to its component. Then we can create a service manual ticket to reference the moved examples.

Closing this ticket for now.

The other components list above need not require an example as they were created to be used by other components.