Skip to content

Commit 239b2c5

Browse files
chore(docs): fix formatting on Progress Steps docs (#4101)
* chore(docs): fix formatting on Progress Steps docs * chore: combine timeline comparison with ordered display list * chore: reorder heading to match content order * chore: add timeline anchor * chore: update Timeline docs with same content * chore: update List docs with same content --------- Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
1 parent fb3dc48 commit 239b2c5

File tree

3 files changed

+23
-40
lines changed

3 files changed

+23
-40
lines changed

packages/paste-website/src/pages/components/list/index.mdx

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Lists are a number of connected list items that are printed consecutively, typic
8686
- Lists should align with the font-size, font-weight, and line-height of paragraphs, but are styled with bullets or numbers.
8787
- Lists can have similar children elements as paragraphs to provide emphasis on a certain word or phrase.
8888

89-
### Ordered Display List vs Progress Steps
89+
### Progress Steps vs Ordered Display List vs Timeline
9090

9191
**Progress Steps**
9292

@@ -97,6 +97,10 @@ Lists are a number of connected list items that are printed consecutively, typic
9797

9898
Ordered Display Lists structure tasks but don’t show progression or status through a multi-step task.
9999

100+
**Timeline**
101+
102+
- [Timeline](/components/timeline) displays the history or sequence of events, focusing on what has happened over time.
103+
- Use Timeline when user interaction is secondary, and progress does not depend on user actions since the process continues even without direct user input.
100104
### Accessibility
101105

102106
- `ListItem`s should always have an `OrderedList` or `UnorderedList` parent component.

packages/paste-website/src/pages/components/progress-steps/index.mdx

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Each step can communicate one of these statuses:
9393
- **Error**: The user has interacted with this step but more action is required that will prevent completing the full task.
9494
- **Incomplete + Disabled**: This step is not yet reached by a user.
9595

96-
### Ordered Display List vs Progress Steps
96+
### Progress Steps vs Ordered Display List vs Timeline
9797

9898
**Progress Steps**
9999

@@ -104,6 +104,11 @@ Each step can communicate one of these statuses:
104104

105105
[Ordered Display Lists](/components/list#ordered-display-list) structure tasks but don’t show progression or status through a multi-step task.
106106

107+
**Timeline**
108+
109+
- [Timeline](/components/timeline) displays the history or sequence of events, focusing on what has happened over time.
110+
- Use Timeline when user interaction is secondary, and progress does not depend on user actions since the process continues even without direct user input.
111+
107112
### Accessibility
108113

109114
- Give each step a concise label describing what the goal of that step is.
@@ -237,28 +242,6 @@ Each step within the Progress Steps component has a label which can be set to ad
237242
{i18nExample}
238243
</LivePreview>
239244

240-
241-
### Timeline vs. Progress Steps
242-
243-
Use Progress Steps:
244-
245-
<UnorderedList>
246-
<ListItem>To guide users through a sequence of steps necessary to complete a task.</ListItem>
247-
<ListItem>
248-
When user interaction is required at certain points in a process and actions are necessary to complete a goal.
249-
</ListItem>
250-
</UnorderedList>
251-
252-
Use Timeline:
253-
254-
<UnorderedList>
255-
<ListItem>To display the history or sequence of events, focusing on what has happened over time.</ListItem>
256-
<ListItem>
257-
When user interaction is secondary, and progress does not depend on user actions, ensuring the process continues
258-
even without direct user input.
259-
</ListItem>
260-
</UnorderedList>
261-
262245
## Composition Notes
263246

264247
- Each step must have a label. Keep the label concise with fewer than 5 words per label.

packages/paste-website/src/pages/components/timeline/index.mdx

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -107,26 +107,22 @@ Timelines can be used in different use cases, such as tracking milestones, monit
107107
</ListItem>
108108
</UnorderedList>
109109

110-
### Timeline vs. Progress Steps
110+
### Progress Steps vs Ordered Display List vs Timeline
111111

112-
Use Timeline:
112+
**Progress Steps**
113113

114-
<UnorderedList>
115-
<ListItem>To display the history or sequence of events, focusing on what has happened over time.</ListItem>
116-
<ListItem>
117-
When user interaction is secondary, and progress does not depend on user actions, ensuring the process continues
118-
even without direct user input.
119-
</ListItem>
120-
</UnorderedList>
114+
- [Progress Steps](/components/progress-steps) show users an outline of a complex multi-step task across multiple pages or apps.
115+
- Progress Steps convey progression and have interactive status states.
121116

122-
Use Progress Steps:
117+
**Ordered Display List**
118+
119+
[Ordered Display Lists](/components/list#ordered-display-list) structure tasks but don’t show progression or status through a multi-step task.
120+
121+
**Timeline**
122+
123+
- Timeline displays the history or sequence of events, focusing on what has happened over time.
124+
- Use Timeline when user interaction is secondary, and progress does not depend on user actions since the process continues even without direct user input.
123125

124-
<UnorderedList>
125-
<ListItem>To guide users through a sequence of steps necessary to complete a task.</ListItem>
126-
<ListItem>
127-
When user interaction is required at certain points in a process and actions are necessary to complete a goal.
128-
</ListItem>
129-
</UnorderedList>
130126

131127
## Examples
132128

0 commit comments

Comments
 (0)