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

[Toggle]: Usage tab #4215

Closed
16 tasks done
alina-jacob opened this issue Aug 23, 2024 · 0 comments · Fixed by #4440
Closed
16 tasks done

[Toggle]: Usage tab #4215

alina-jacob opened this issue Aug 23, 2024 · 0 comments · Fixed by #4440

Comments

@alina-jacob
Copy link
Member

alina-jacob commented Aug 23, 2024

Acceptance criteria

Update the Usage tab with the usage content template.


  • Convert all the "action text" to "state text", both in images and texts (Michael's explanation below)
  • Change "Label" to "Reminder" in all the images.

Overview

When to use and When not to use

  • Decide whether we need these sections or not in the docs. Do we have helpful information that we could list here?

Variants

  • The image here should be under the overview section not the variants section.

Formatting

Anatomy

  • In the description:
    • instead of "component label" it should say "label text".
    • Check if the word on, when referencing the on state, should have quotes around it. We need to be compliant with IBM style there. In general, I would say "on state" for more context.
    • There is an inconsistency for C. where it is labeled as "State text" in the image, and "Action text" in the list. Which one is it? I assume its probably "Action text". Reach out to Alina for further context.

      Michael's response: STATE TEXT

      The state is either On or Off, which is normally what that text says. I would make the illustration say On.
      I’d also suggest you make the “Label” in the illustration say something more demonstrative, like “Reminder”. The fact that it is a label is described in the anatomy text underneath. This is something of a philosophical discussion, but my understanding was that Carbon was moving to using less abstract names in the illustration so that it was more recognizable as a typical example.

      In the anatomy text underneath, I’d quibble about calling it "action" because it is actually the opposite of the action. If I click on the toggle when it says “On” it is actually going to turn it off. So I think state or current state is more accurate.

    • In the list below the image, "A. Label" should say "A. Label text" for terminology consistency.

Sizing

  • Add this section and image to the docs

Behaviors

States

  • In the description text, only "Style" should be the link to the Style tab. The word tab can be regular text.

Interactions

  • Add this section to the docs

Clickable areas

  • Add this section and image to the docs

Related

  • Add this section and image to the docs

PR

  • Create PR
  • PR review
@github-project-automation github-project-automation bot moved this to Triage in Roadmap Aug 23, 2024
@alina-jacob alina-jacob moved this to ⏱ Backlog in Design System Aug 23, 2024
@alina-jacob alina-jacob moved this from Triage to Later in Roadmap Aug 23, 2024
@laurenmrice laurenmrice moved this from Later to Icebox in Roadmap Sep 6, 2024
@laurenmrice laurenmrice moved this from Later 🧊 to Now 💫 in Roadmap Jan 9, 2025
@laurenmrice laurenmrice moved this from Now 💫 to Next ➡ in Roadmap Jan 9, 2025
@laurenmrice laurenmrice moved this to ⏱ Backlog in Design System Jan 9, 2025
@laurenmrice laurenmrice added this to the 2025 Q1 milestone Jan 9, 2025
@Kritvi-bhatia17 Kritvi-bhatia17 moved this from ⏱ Backlog to 🏗 In Progress in Design System Jan 10, 2025
@laurenmrice laurenmrice moved this from Next ➡ to Now 💫 in Roadmap Jan 13, 2025
@sstrubberg sstrubberg removed this from Roadmap Jan 14, 2025
@sstrubberg sstrubberg removed this from the 2025 Q1 milestone Jan 22, 2025
@laurenmrice laurenmrice added this to the 2025 1H milestone Jan 23, 2025
@Kritvi-bhatia17 Kritvi-bhatia17 moved this from 🏗 In Progress to 🚦 In Review in Design System Jan 24, 2025
@github-project-automation github-project-automation bot moved this from 🚦 In Review to ✅ Done in Design System Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment