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

doc(list): Update the Style tab with the latest content template #4477

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

Kritvi-bhatia17
Copy link
Contributor

@Kritvi-bhatia17 Kritvi-bhatia17 commented Feb 19, 2025

Closes #4424

Update the Style tab with the latest content template and fixed a few more sections.

Changelog

New

  • Added a few sections:
    • Description
    • Anchor links
    • Feedback

Changed

  • Updated the order of the list's variants in all sections (text & image): Start with Unordered first, then Ordered
  • Updated a few images

Copy link

vercel bot commented Feb 19, 2025

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 Feb 19, 2025 5:11pm

@laurenmrice
Copy link
Member

@guidari When you get a chance, can you fix the deploy preview? Thank you!

Copy link
Contributor

Deploy preview successfully published at https://4477--carbondesignsystem.netlify.app with commit (d789385)

There are two types of lists, ordered and unordered. Level 1 ordered list points
are marked numerically while level 2 points are marked with letters. Level 1
unordered list points are dashed while level 2 points are marked with a dot.
There are two types of lists: unordered and ordered. Both have the same
Copy link
Member

Choose a reason for hiding this comment

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

For this section, instead of introducing more heading levels, I would just stick with being concise in one paragraph and let the image visual do the work to explain dashes, letters, etc. Also I would either use the word "marked" or "prefixed" when thinking about how to describe them. And think about how you will be describing this in the Anatomy section on the Usage tab to be consistent with the terminology you want to use. Here is an example below.

Frame 1

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.

List: Style tab
3 participants