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

Review Example tabs naming convention #718

Open
4 tasks
RobTobias123 opened this issue Sep 23, 2024 · 2 comments
Open
4 tasks

Review Example tabs naming convention #718

RobTobias123 opened this issue Sep 23, 2024 · 2 comments
Labels
Type: Documentation Improvements or additions to documentation

Comments

@RobTobias123
Copy link
Contributor

RobTobias123 commented Sep 23, 2024

Outcome

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

Scope

  • Review issues and approach for improvement opportunity
  • Team agreement on way forward
  • Validate with some internal users
  • Consistently apply changes as appropriate
@RobTobias123 RobTobias123 added the Type: Documentation Improvements or additions to documentation label Sep 23, 2024
@RobTobias123
Copy link
Contributor Author

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
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant