Improve component documentation descriptions for clarity and consistency #3595
+21
−20
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…or" and "best practices"
davebcn87
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Updated description fields in the following component documentation files:
Forms: Checkbox, ChoiceList, ColorField, ColorPicker, DateField, DatePicker
Actions: ButtonGroup, ClickableChip, Link, Menu
Structure: Divider, Grid, Page, Table
Overlays: Modal, Popover, Tooltip
Media: Avatar, Thumbnail
Titles and text: Paragraph
Motivation
Component descriptions should clearly communicate what each component does and when to use it, helping developers quickly identify the right component for their use case.
Checklist