newscorp-ghfb/NewsKit

Docs site page for Card Composable

Closed this issue · 7 comments

Description

Implement the docs site page based on Design's

Business Benefit/Value

Standard part of new component release

Acceptance Criteria

Should match designs

Design

Illustrations files

Supporting Information

Process/sequence flows, wireframes, third party documentation, tech feasibility, architecture overview/documentation, high level design, data specs etc...

Dependencies

Any known business dependencies or reasons to engage with another team and input into their roadmap/timings

Thanks @jannuk59, looking good - a few edits please:

Options: Card as a Link

  • Please format the word expand:

Image

as code, like this:
Image

  • Usage: Don’t use varying heights in a group of cards
    Add a link to the MDN reference: Card - CSS: Cascading Style Sheets | MDN

  • Accessibility considerations
    Please remove all full stops, for consistency

Please indent these three bullets - see the design:
Image

  • Last bullet - please format the word expand as code

  • Please change the copy
    "Don't wrap the whole card in a Link, use //expand// prop to make it look like it."
    to
    "Don't wrap the whole card in a Link, use the //expand// prop to make it interactive"

  • WAI-ARIA
    Please change this text
    Image
    New text: Image alt text, if the image is not decorative. Alt text needs to be different from the card title.

  • SEO considerations
    Remove all full stops

Thanks Janani, have a great weekend!

@jannuk59 Looks good. Just a few additional comments:

  • Anatomy section - add link to "Link Standalone" https://newskit.co.uk/components/link/
  • Related components section - Only include Grid Layout
  • Below the CardComposable API table there should be an inline message
    image

@GeriReid @nathanparris is ready for re-review

thanks @jannuk59, could you please add the word "prop" back in after expand in these two places? So it reads expand prop:

image
image

Nathan also suggested in the related components section to only include Grid Layout, instead of the 4 current components.

thanks!

Looks good, thanks for the edits @jannuk59 - happy to approve.