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

Open
1 of 10 tasks
Tracked by #2085
alina-jacob opened this issue Aug 23, 2024 · 0 comments
Open
1 of 10 tasks
Tracked by #2085

[Toggle]: Usage tab #4215

alina-jacob opened this issue Aug 23, 2024 · 0 comments

Comments

@alina-jacob
Copy link
Member

alina-jacob commented Aug 23, 2024

Acceptance criteria

Update the Usage tab with the usage content template.


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.

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.
  • In the list below the image, "A. Label" should say "A. Label text" for terminology consistency.

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
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🏗 In Progress
Development

No branches or pull requests

3 participants