Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs site page for Card Composable #822

Closed
JohnTParsons opened this issue Apr 11, 2023 · 7 comments · Fixed by #876
Closed

Docs site page for Card Composable #822

JohnTParsons opened this issue Apr 11, 2023 · 7 comments · Fixed by #876
Assignees
Labels
story a user facing change
Milestone

Comments

@JohnTParsons
Copy link
Collaborator

JohnTParsons commented Apr 11, 2023

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

@JohnTParsons JohnTParsons added triage This issue will be reviewed by the team story a user facing change labels Apr 11, 2023
@JohnTParsons JohnTParsons added this to the Card V2 milestone Apr 11, 2023
@jps jps removed the triage This issue will be reviewed by the team label Apr 11, 2023
@jannuk59 jannuk59 self-assigned this Apr 27, 2023
@jannuk59
Copy link
Contributor

jannuk59 commented May 5, 2023

@GeriReid
Copy link
Contributor

GeriReid commented May 5, 2023

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!

@nathanparris
Copy link
Contributor

@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

@jannuk59
Copy link
Contributor

@GeriReid @nathanparris is ready for re-review

@GeriReid
Copy link
Contributor

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!

@jannuk59
Copy link
Contributor

jannuk59 commented May 15, 2023

@GeriReid
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
story a user facing change
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants