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: update progress indicator usage tab #3924

Conversation

aubrey-oneal
Copy link
Member

@aubrey-oneal aubrey-oneal commented Feb 16, 2024

Closes #3464

This is issue is a complete rewrite of the progress indicator usage tab, which does not currently follow our template or provide sufficient information.

Changelog

New

  • Full content rewrite
  • New images

Copy link

vercel bot commented Feb 16, 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 Mar 25, 2024 4:37pm

@guidari
Copy link
Contributor

guidari commented Feb 22, 2024

Hey @aubrey-oneal
The end of the page is missing any content? I can see the titles but no content:

Screenshot 2024-02-22 at 09 16 22

@aubrey-oneal
Copy link
Member Author

Hey @guidari I put up a WIP PR which is why you're seeing missing content. I still need to work on the Placement imagery but I'd like to request a first review from our designers. One tricky thing was naming the progress states and I'm open to feedback on that. It's tricky because the states implied in the style tab have a mismatch with the icon names they use. I.e. 'Current' state uses the 'Incomplete' icon and 'Incomplete' state uses the 'Not started' icon.

@guidari
Copy link
Contributor

guidari commented Feb 26, 2024

@aubrey-oneal Ohh okay!
If you think we should change the icons, I'm happy to help in the dev side.

@aubrey-oneal
Copy link
Member Author

Thanks for the offer @guidari! I think for this PR our scope is going to be just getting docs up for the component as it is and we'll make some issues for potential future component updates!

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.

Looking good Aubrey, just a couple comments:

src/pages/components/progress-indicator/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/progress-indicator/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/progress-indicator/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/progress-indicator/usage.mdx Outdated Show resolved Hide resolved
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.

Just had 3 overall comments of some of the images being 12 columns instead of 8 columns.

alignment.

<Row>
<Column colLg={8}>
Copy link
Member

Choose a reason for hiding this comment

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

  • You designed this image at 12 columns in your Figma file, so just checking if you still want it at 12 columns here instead of 8 columns!
Screenshot 2024-03-19 at 2 55 34 PM

src/pages/components/progress-indicator/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/progress-indicator/usage.mdx Outdated Show resolved Hide resolved
@thyhmdo
Copy link
Member

thyhmdo commented Mar 21, 2024

Looks good Aubrey!

I just think the anatomy image spanning 12 columns looks huge compared to the 8-column one. But yeah I understand the real size component is bigger than the 8–column image. I tried to scale it but not sure how that'll look live. But it's up to you.

I also noticed that we have italic text for the first heading column and non -italic text in some cases. Maybe something to look at in the usage template update. But Lauren just issued the tag doc and she has italic text so I'd follow that for the states.

image


| State | Description |
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Completed | A step is complete when a user has filled out the required information within a step and progressed to the following step. When possible, use validation to confirm that a step has been completed before the user continues. All steps that have been completed are indicated by an outlined circle with a checkmark and a blue active line. |
Copy link
Member

Choose a reason for hiding this comment

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

Consider formatting the state names in italic text

@aubrey-oneal aubrey-oneal merged commit 10607c2 into carbon-design-system:main Mar 25, 2024
7 checks passed
@aubrey-oneal aubrey-oneal deleted the progress-indicator-usage-3464 branch March 25, 2024 16:44
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.

Progress indicator: Usage tab
5 participants