centrica-engineering / nucleus-docs

Documentation for the Nucleus Design System
https://nucleus.design
2 stars 10 forks source link

Review Example tabs naming convention #718

Open RobTobias123 opened 1 month ago

RobTobias123 commented 1 month ago

Outcome

Clarity of understanding and applied convention of tabs and naming - addressing the situation of duplicate Tab names that may cause confusion.

Scope

RobTobias123 commented 1 month ago

I'd like us to review our approach to the naming of the example Tabs in our Docs.

For me, it seems a little confusing having a tab called 'Standard' as a child of another 'Standard' tab when there is more than one variant. My thoughts are to perhaps name one of these 'Default' instead?

Eg.

   <TabItem label="Standard">
    TODO Standard
    <Tabs>
      <TabItem label="Standard">
        <ExampleViewer type="standard" />
      </TabItem>
      <TabItem label="Custom">
        The heading and first paragraph may be customised if the default content is not suitable.
        <ExampleViewer type="standard-custom" />
      </TabItem>
        <Tabs>
RobTobias123 commented 1 month ago

Screenhsot of the Example issue, showing 2 tabs of Standard is potentially confusing. Options to resolve may be using teh word 'default' for the child, and/or indentation of the second set of tabs to indicate hierarchy/relationship...

Image