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 (notifications): usage and style guidance for Callout #4218

Merged
merged 13 commits into from
Nov 11, 2024

Conversation

benjamin-kurien
Copy link
Contributor

@benjamin-kurien benjamin-kurien commented Aug 26, 2024

Closes #3913

Usage & style document for Notification component has been updated to include guidance for a 4th variant named Callout.

Changelog

New

  • Anchor link to Callout section
  • Added a paragraph under overview introducing notifications.
  • Added a section to describe various notification statuses.
  • Added guidance to main elements section for changes related Callout
  • Added guidance to the style tab for specifications related to the Callout variant.

Changed

  • Added Callout to the variants table.
  • Added Callout to the anatomy image, improved the overall layout for the image, and changed the anatomy list to individually address each variant.
  • Added documentation for callout including its overview, guidance for actions, formatting and placement, and the required images
  • Heading for variants changed to be consistent.

Removed

  • Content for main elements that were specific to any variant was removed from this section. This is instead explained in detail under the relevant sections.
  • Recommendation to use only the title to communicate the entire message - was removed. Guidance to keep the message short and concise was retained.

Copy link

vercel bot commented Aug 26, 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 Nov 11, 2024 2:42pm

Copy link
Contributor

github-actions bot commented Aug 26, 2024

DCO Assistant Lite bot All contributors have signed the DCO.

@benjamin-kurien
Copy link
Contributor Author

I have read the DCO document and I hereby sign the DCO.

Copy link
Member

@aagonzales aagonzales left a comment

Choose a reason for hiding this comment

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

The docs are looking good, just a few small tweaks

  • The anatomy image should be 12 columns instead 8.
  • See my other inline comments

And then one question:
Do we know when the name change will be made in code? Are we going to wait for that to merge these changes in? If not, then we need to add some information about Callout currently being called StaticNotification in experimental.

src/pages/components/notification/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/notification/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/notification/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/notification/style.mdx Show resolved Hide resolved
@benjamin-kurien
Copy link
Contributor Author

The docs are looking good, just a few small tweaks

  • The anatomy image should be 12 columns instead 8.
  • See my other inline comments

And then one question: Do we know when the name change will be made in code? Are we going to wait for that to merge these changes in? If not, then we need to add some information about Callout currently being called StaticNotification in experimental.

Hi @aagonzales , I have fixed the issues that you mentioned. Can you please review the changes again. Thank you.

@benjamin-kurien
Copy link
Contributor Author

Hi @aagonzales I have updated the anatomy image as requested. Please share your review. Thank you.

Copy link
Member

@aagonzales aagonzales left a comment

Choose a reason for hiding this comment

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

Looks good to go! Good job!

Copy link

@RichKummer RichKummer left a comment

Choose a reason for hiding this comment

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

Made a few minor edits just for clarity. Otherwise looks good!

src/pages/components/notification/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/notification/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/notification/usage.mdx Outdated Show resolved Hide resolved
src/pages/components/notification/usage.mdx Outdated Show resolved Hide resolved
Copy link

@RichKummer RichKummer left a comment

Choose a reason for hiding this comment

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

Thanks for making the updates @benjamin-kurien ! LGTM

@benjamin-kurien
Copy link
Contributor Author

benjamin-kurien commented Sep 9, 2024

PR ready to merge.
Waiting for devs to make the required name changes to storybook, before merging this PR.

@benjamin-kurien benjamin-kurien merged commit 8911162 into carbon-design-system:main Nov 11, 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.

[Callout] website docs: component
8 participants