Skip to content

[Docs] AI overview guidelines #4113

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.

Sign up for GitHub

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

Merged
merged 21 commits into from
Jul 1, 2024
Merged

[Docs] AI overview guidelines #4113

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
8362e4c
[Docs] AI overview guidelines
aagonzales Jun 11, 2024
ffc5821
Add component list
aagonzales Jun 11, 2024
b0f90a6
Update nav-items.yaml
aagonzales Jun 11, 2024
9e6a7dc
update page name
aagonzales Jun 12, 2024
1529b83
update name again
aagonzales Jun 12, 2024
8045f54
updated-component-list
aagonzales Jun 12, 2024
22f7563
Apply suggestions from code review
aagonzales Jun 13, 2024
ac08377
Added slack links
aagonzales Jun 13, 2024
7b476df
chore: fix merge conflict
alisonjoseph Jun 13, 2024
02aba14
updated-images
aagonzales Jun 14, 2024
a079ed4
Delete install-state.gz
aagonzales Jun 14, 2024
7fde7ac
Update ai-components-dark.png
aagonzales Jun 17, 2024
e7dff99
updated-vertical-dividers-images
aagonzales Jun 17, 2024
155b351
Content updates: Review from Mike
aagonzales Jun 19, 2024
432b45b
For-IBMer-content-update
aagonzales Jun 20, 2024
9b7901a
content-updates-ibmers
aagonzales Jun 21, 2024
b08eaf9
Update src/pages/guidelines/carbon-for-ai/index.mdx
aagonzales Jun 24, 2024
9d8cc8b
suggestions-from-kritvi
aagonzales Jun 24, 2024
565017f
Merge branch 'main' into ai-overview-page
aagonzales Jun 24, 2024
9a23d32
removed-label-link
aagonzales Jul 1, 2024
89b883f
Merge branch 'main' into ai-overview-page
aagonzales Jul 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed .yarn/install-state.gz
View file
Open in desktop
Binary file not shown.
2 changes: 2 additions & 0 deletions src/data/nav-items.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@
pages:
- title: Accessibility
path: /guidelines/accessibility/overview/
- title: Carbon for AI
path: /guidelines/carbon-for-ai/
- title: Content
path: /guidelines/content/overview/
- title: Components
Expand Down
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-accessibility-dark.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-accessibility-light.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-chat-dark.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-chat-light.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-components-dark.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-components-light.png
View file
Open in desktop
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
Collaborator Author

@aagonzales aagonzales Jun 24, 2024 •
edited
Loading

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!

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-components-revert.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-explainability-dark.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-explainability-light.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-label-dark.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-label-in-context.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-label-light.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-overview.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-style-elements-dark.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/ai-style-elements-light.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-checkbox.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-data-table.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-date-picker.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-dropdown.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-form.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-modal.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-number-input.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-radio-button.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-select.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-tag.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-text-input.png
View file
Open in desktop
Binary file added src/pages/guidelines/carbon-for-ai/images/mini-tile.png
View file
Open in desktop
Loading