Change Details

## Background We need to review the content of each component's guidelines in Codex. We will need to: ===== All components: **High impact:** - Review the content in each component's demo page and make sure the information is not duplicated in the Guidelines and Demos sections **Medium impact:** - Color's documentation: decide if we want to use the option token's name (e.g. `Gray200`) or the decision one (e.g. `background-color-disabled-subtle`)~~ To be discussed in a future DST Design/Eng sync instead of creating a task - Evaluate if we want to remove the "Interaction states" section from the guidelines - Evaluate if we want to rename the "Specifications" section to "Anatomy" **Low impact:** - References section: just the components moved from the DSG contain a "References" section. We need to review the [[ https://docs.google.com/document/d/1ijapYGCW_0MP3PT5A6DyDooUtcq_ndp4gbK1-A3io7k/edit#heading=h.uteb407jne6h | new Codex components ]] list and include references when needed - Also decide where to put the References, if we continue with it. Right now it's hanging in the air underneath Guidelines, where the more natural expectation would be to have it end of page. - If References, then add direct link references, not links to the heading. For satisfying UX and a11y needs: See https://gerrit.wikimedia.org/r/c/design/codex/+/959603/14/packages/codex-docs/component-demos/button/button.md for example. We put in a enumerated list of Reference ids, otherwise the link is no semantic connection. We can leave this for post MVP. - We could improve the component's guidelines by adding: - Do and Don'ts to explain how to use the component - Content recommendations for components - Keyboard navigation info ===== Components specific content: **High impact:** - Button: revisit the documentation in the "[[ https://doc.wikimedia.org/codex/main/components/demos/button.html#types | Types ]]" section. - Card: in the "[[ https://doc.wikimedia.org/codex/main/components/demos/card.html#interaction-states | Interaction states ]]" section just the `with link` version is currently represented We need to represent both `default` and [[ URL | with link ]] cards. --- ### Acceptance criteria [] Evaluate each one of the items in the list above and create subtasks if needed [] Update the components guidelines in Codex

## Background We need to review and improve the content in the component guidelines in Codex. We need to: ===== All components: **High impact:** - Review the content in each component's demo page and make sure the information is not duplicated in the Guidelines and Demos sections **Medium impact:** - Color's documentation: decide if we want to use the option token's name (e.g. `Gray200`) or the decision one (e.g. `background-color-disabled-subtle`)~~ To be discussed in a future DST Design/Eng sync instead of creating a task - Evaluate if we want to remove the "Interaction states" section from the guidelines - Evaluate if we want to rename the "Specifications" section to "Anatomy" **Low impact:** - References section: just the components moved from the DSG contain a "References" section. We need to review the [[ https://docs.google.com/document/d/1ijapYGCW_0MP3PT5A6DyDooUtcq_ndp4gbK1-A3io7k/edit#heading=h.uteb407jne6h | new Codex components ]] list and include references when needed - Also decide where to put the References, if we continue with it. Right now it's hanging in the air underneath Guidelines, where the more natural expectation would be to have it end of page. - If References, then add direct link references, not links to the heading. For satisfying UX and a11y needs: See https://gerrit.wikimedia.org/r/c/design/codex/+/959603/14/packages/codex-docs/component-demos/button/button.md for example. We put in a enumerated list of Reference ids, otherwise the link is no semantic connection. We can leave this for post MVP. - We could improve the component's guidelines by adding: - Do and Don'ts to explain how to use the component - Content recommendations for components - Keyboard navigation info ===== Components specific content: **High impact:** - Button: revisit the documentation in the "[[ https://doc.wikimedia.org/codex/main/components/demos/button.html#types | Types ]]" section. - Card: in the "[[ https://doc.wikimedia.org/codex/main/components/demos/card.html#interaction-states | Interaction states ]]" section just the `with link` version is currently represented We need to represent both `default` and [[ URL | with link ]] cards. --- ### Acceptance criteria [] Evaluate each one of the items in the list above and create subtasks if needed [] Update the components guidelines in Codex

## Background We need to review and improve the content of eachin the component's guidelines in Codex. We will need to: ===== All components: **High impact:** - Review the content in each component's demo page and make sure the information is not duplicated in the Guidelines and Demos sections **Medium impact:** - Color's documentation: decide if we want to use the option token's name (e.g. `Gray200`) or the decision one (e.g. `background-color-disabled-subtle`)~~ To be discussed in a future DST Design/Eng sync instead of creating a task - Evaluate if we want to remove the "Interaction states" section from the guidelines - Evaluate if we want to rename the "Specifications" section to "Anatomy" **Low impact:** - References section: just the components moved from the DSG contain a "References" section. We need to review the [[ https://docs.google.com/document/d/1ijapYGCW_0MP3PT5A6DyDooUtcq_ndp4gbK1-A3io7k/edit#heading=h.uteb407jne6h | new Codex components ]] list and include references when needed - Also decide where to put the References, if we continue with it. Right now it's hanging in the air underneath Guidelines, where the more natural expectation would be to have it end of page. - If References, then add direct link references, not links to the heading. For satisfying UX and a11y needs: See https://gerrit.wikimedia.org/r/c/design/codex/+/959603/14/packages/codex-docs/component-demos/button/button.md for example. We put in a enumerated list of Reference ids, otherwise the link is no semantic connection. We can leave this for post MVP. - We could improve the component's guidelines by adding: - Do and Don'ts to explain how to use the component - Content recommendations for components - Keyboard navigation info ===== Components specific content: **High impact:** - Button: revisit the documentation in the "[[ https://doc.wikimedia.org/codex/main/components/demos/button.html#types | Types ]]" section. - Card: in the "[[ https://doc.wikimedia.org/codex/main/components/demos/card.html#interaction-states | Interaction states ]]" section just the `with link` version is currently represented We need to represent both `default` and [[ URL | with link ]] cards. --- ### Acceptance criteria [] Evaluate each one of the items in the list above and create subtasks if needed [] Update the components guidelines in Codex