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

(docs) Content template: updated style sections #4197

Merged

Conversation

aagonzales
Copy link
Member

@aagonzales aagonzales commented Aug 13, 2024

Closes #4180

Updated the content template to include a section for Style tab with multiple variants

Changelog

New

  • Added "Style template: for components with multiple variants"
  • Added an "AI presence" template section to both "one variant" and "multiple variants" sections (style tab only)

Changed

  • Updated "Style template: for components with one variant" to be exclusive about a single variant. I removed any information that was talking about variant structure.
  • Reformatted the instructional comments to be more skimmable.

Copy link

vercel bot commented Aug 13, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
carbondesignsystem ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 20, 2024 0:39am

Copy link
Contributor

@benjamin-kurien benjamin-kurien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good @aagonzales

Copy link
Member

@laurenmrice laurenmrice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks really good, and its working well for my Pagination Style tab docs!

Going to approve and I think one thing you could add to the Typography section is to be more explicit about how to treat different variants that have different type specs, since Pagination ran into that issue.

Copy link
Contributor

@Kritvi-bhatia17 Kritvi-bhatia17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @aagonzales! This looks great. 🔥
I just wanted to confirm one small thing: the current docs mention "interactive state," but in the updated document templated, it says "interactive state color." Which one is correct? As this could lead to changes in almost all the components' docs.

Screenshot 2024-08-16 at 12 11 04 PM Screenshot 2024-08-16 at 12 18 00 PM

@aagonzales
Copy link
Member Author

@Kritvi-bhatia17 oh yes good catch. I think Aubrey changed it to "interactive state color" the last time she updated the template so I just kept it that way. You are right to point out its inconsistent with what's showing in most docs. We probably need to do a content scrub to make sure all our style tabs will reflect the new template.

Copy link
Contributor

@Kritvi-bhatia17 Kritvi-bhatia17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🎉

@alisonjoseph alisonjoseph enabled auto-merge (squash) August 20, 2024 12:33
@alisonjoseph alisonjoseph merged commit f90f04d into carbon-design-system:main Aug 20, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Content templates] Style template: for components with multiple variants
5 participants