carbon-website icon indicating copy to clipboard operation
carbon-website copied to clipboard

[Content templates] Usage template: for components with multiple variants

Open laurenmrice opened this issue 1 year ago • 1 comments

Acceptance criteria

Update the Usage template, for components with multiple variants, with the following changes:


Anchor links

  • [ ] Update Anchor link information to start with "Live demo" and then"Overview". (This change came out of the A11y component status work.)
  • [ ] Reorder sections on the page to reflect the order of the anchor links.

Variants section

  • [ ] Update the section heading from "Types" to "Variants" and update this anywhere where this is referenced throughout the template.

Individual H2s for variants

  • [ ] Decide whether we should keep this rule or not, because we are not always following it right now.
    • These variants will appear as individual anchor links at the top of the page. Depending on he amount of variants, it could get long. I can see pros and cons for still keeping it or removing it. Advise Aubrey

States section

  • [ ] Recommend that we show a table in this section with all the states and their descriptions. and link to the style tab for more details and imagery.
  • [ ] Mention not to use italics for each state name in the table, or refer to a component that currently is not using italics for this. (This came as a recommendation from Mike to not be using italics here.)

New A11y section

  • [ ] Add a section in the template about the new "Accessibility testing status" section.

Example content

  • [ ] Under each header provide example content with markdown formatting (See the style template as an example)

Consider this feedback from Laura Snider (IBM content) CDS-Datatable-restructure suggestions.pdf

Review

  • [ ] Get Aubrey's review

laurenmrice avatar Mar 20 '24 13:03 laurenmrice

One variant template can help pave the way for this issue

thyhmdo avatar Mar 21 '24 14:03 thyhmdo