ic-design-system icon indicating copy to clipboard operation
ic-design-system copied to clipboard

Consistency between the component guidance pages

Open GCHQ-Developer-465 opened this issue 2 years ago • 0 comments

Summary

There is inconsistency between the component guidance pages. They should follow the same format to avoid confusion and for the site to be consistent.

💬 Description

There needs to be more consistency between the component guidance pages. There are some which start off with an introduction where others start off with the component demo. The ones which have the Introduction section don't have a 'Component demo' section. Also some component guidance pages start off with 'Component variants'.

There needs to be consistency between the pages. The Introduction section should include Component variants (if needed) and Component demo. These two sections should be under the Introduction header.

For instance: Introduction

  • Component demo
  • Component variants (if needed)

Additional info

Here is what each component has:

Introduction...

  • Accordion (Introduction)
  • Alert (Introduction)
  • Back to top (Introduction)
  • Breadcrumb (Introduction)
  • Checkbox (Introduction)
  • Classification banner (Introduction)
  • Data Entity (Introduction)
  • Footer (Introduction)
  • Hero (Introduction)
  • Page header (Introduction)
  • Popoover (Introduction)
  • Radio (Introduction)
  • Search bar (Introduction)
  • Side navigation (Introduction)
  • Skeleton (Introduction)
  • Status tag (Introduction)
  • Switch (Introduction)
  • Tabs (Introduction)
  • Toast (Introduction)
  • Tooltip (Introduction)
  • Typography (Introduction)

Introduction and Component variants

  • Badge (Introduction, Component variants)
  • Pagination (Introduction, Component variants)
  • Stepper (Introduction, Component variants)

Component variants

  • Button (Component variants)
  • Card (Component variants)
  • Chip (Component variants)
  • Link (Component variants)
  • Loading indicator (Component variants)
  • Select (Component variants)
  • Text field (Component variants)
  • Top navigation (Component variants)

Introduction and Component demo

  • Dialog (Introduction, Component demo)
  • Section container (Introduction, Component demo)

Component demo

  • Empty State (Component demo)

GCHQ-Developer-465 avatar Dec 20 '23 10:12 GCHQ-Developer-465