Update ns-product-card docs

centrica-engineering / nucleus-docs

Documentation for the Nucleus Design System

https://nucleus.design

2 stars 10 forks source link

Update ns-product-card docs #723

Open RobTobias123 opened 4 weeks ago

RobTobias123 commented 4 weeks ago

Outcome

An updated Nucleus Docs page for the ns-product-card component, to include latest changes for 'horizontal +' with examples and content guidance etc.

Scope

[x] Branch
[x] Purpose - check still relevant
[x] Content revision
[ ] Update HTML examples
[x] Guidance - Do/Don'ts
[x] Guidance - Diagram and key
Implementation - Placement (automated from component once built)
Spec/Spec notes (automated from component once built)
[x] Apply 'updated' badge to LHS menu.
[x] Share iterations for feedback ad adjustment.
[ ] Merge on approval and coincide with release of code

Child of Epic: #796

RobTobias123 commented 1 week ago

Branch: chore/update-ns-product-card-with-horizontal-type

RobTobias123 commented 1 week ago

Initial draft and format created to accommodate horizontal type - for further additions.

PR: https://github.com/centrica-engineering/nucleus-docs/pull/727

RobTobias123 commented 6 days ago

Added 1x1 720px sq asset to this and section in guidelines/assets page to fit in with current 720 width 4/3 and 16/9 defined for ns-product-card. Updated and checked link in the product-card docs.

RobTobias123 commented 6 days ago

Added 'updated' to the badge.json - IIRC this will show when the JSDoc updates?

RobTobias123 commented 6 days ago

Just the HTML examples left outstanding now - these are dependent on the build being completed first. The horizontal guidance image has been created from the concept Figma component at the moment but can and should be updated with a screenshot of the real thing once available.