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] AI overview guidelines #4113

Merged
merged 21 commits into from
Jul 1, 2024

Conversation

aagonzales
Copy link
Member

@aagonzales aagonzales commented Jun 11, 2024

Related #3997

Added a new page under the guidelines sections for "Carbon for AI."

Changelog

New

  • Guidelines/Carbon-for-AI

Note

  • Some links will 404 until the Design for AI site is live.

Ready for review but do not merge
We are waiting to roll this out at a specific time later in the week to publish at the same time as the Design for AI site udpates. Do not automatically merge it.

Copy link

vercel bot commented Jun 11, 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 Jul 1, 2024 2:00pm

aagonzales and others added 2 commits June 13, 2024 10:03
Co-authored-by: Alison Joseph <alisonejoseph@Gmail.com>
@aagonzales aagonzales requested a review from alisonjoseph June 13, 2024 15:07
@aagonzales
Copy link
Member Author

@alisonjoseph Also do you know what I need to do to resolve the merge conflict?

@alisonjoseph
Copy link
Member

@aagonzales I'll push a fix, this file actually doesn't even need to be in github

@aagonzales aagonzales requested a review from alina-jacob June 17, 2024 20:32
Copy link
Member

@alina-jacob alina-jacob 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 me Anna! 🚀

@laurenmrice laurenmrice added this to the 2024 Q2 milestone Jun 19, 2024
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 Anna, pretty amazing work! 🔥
I just have a few small doubts I wanted to clarify.

Copy link
Contributor

Choose a reason for hiding this comment

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

  • I have a small question: Although I know it's just Lorem ipsum text, should we use actual data for the "AI text area" since it's AI generated? Or should we just make the AI text area's data be different from the non-AI text area? 🤔
  • Also, should the label "AI Text area" be in sentence case as "AI text area," or is it fine the way it is?

Copy link
Member Author

@aagonzales aagonzales Jun 24, 2024

Choose a reason for hiding this comment

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

This image shows the styling difference between core carbon and the AI presence. I don't think it necessarily needs to have different content between the two like we'd want with showing the "revert option." The other components in the image don't have real data either so if we were to do real data we would change it across all the components in this image. We'd lose the component name in the label if we did but that's the trade of of doing spec vs real content. Are we trying to help people to understand the structure of the component or how to use the component here?

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh, I see your point. If I understand correctly, since we're showing the structure of the component, it's fine to go ahead with the Lorem Ipsum text. Thank you!

src/pages/guidelines/carbon-for-ai/index.mdx Show resolved Hide resolved
Co-authored-by: thyhmdo <77697351+thyhmdo@users.noreply.github.com>
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.

Looks good to me, Anna! Everything is finally coming together well! 🔥❤️

Copy link
Member

@thyhmdo thyhmdo left a comment

Choose a reason for hiding this comment

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

looks great!

@kodiakhq kodiakhq bot merged commit df57e6a into carbon-design-system:main Jul 1, 2024
7 checks passed
@aagonzales aagonzales deleted the ai-overview-page branch July 1, 2024 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants