Skip to content

Commit 539afc5

Browse files
authored
Update tables.mdx (#23753)
Add a bit more clarity and cross links
1 parent f99a46d commit 539afc5

File tree

1 file changed

+7
-2
lines changed
  • src/content/docs/style-guide/documentation-content-strategy/component-attributes

1 file changed

+7
-2
lines changed

src/content/docs/style-guide/documentation-content-strategy/component-attributes/tables.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,16 @@ Limit tables to three columns (or four if the information is very condensed). Ot
1616

1717
## Use cases
1818

19+
The purpose of a table is to provide a scannable content experience.
20+
1921
Use tables for:
2022

2123
* Simple mappings of data and values
2224
* Categories of things with examples
2325
* Collections of things with different attributes
2426

27+
Each cell within a table should not contain more than **one sentence** of content.
28+
2529
## Usage
2630

2731
We use standard Markdown tables for our documentation.
@@ -52,15 +56,16 @@ When using tables:
5256

5357
* Check whether the tables work for both desktop and mobile users.
5458
* Limit tables to three columns (or four if the information is very condensed).
55-
* Avoid long sentences or information that is so dense that it defeats the purpose of having tabular displays.
59+
* Avoid long sentences or information that is so dense that it defeats the purpose of having tabular displays
5660

5761
### Alternatives
5862

5963
If your information does not fit within the [guidelines](#guidelines), consider using the following methods of presentation:
6064

6165
* Lists
6266
* Subsections
63-
* Tabs
67+
* [Tabs](/style-guide/components/tabs)
68+
* [Details](/style-guide/components/details/)
6469

6570
### Large tables
6671

0 commit comments

Comments
 (0)