Skip to content

Commit 8b863b2

Browse files
ethanpalmclaude
andcommitted
Apply style lessons learned from quickstart and cards feedback
- Use action-oriented introductions ("Use X to..." instead of "The X component...") - Apply sentence case to all section headings ("Properties" not "Props") - Use "Properties" consistently instead of "Props" - Remove unnecessary periods from property descriptions - Update component headings to sentence case - Make language more direct and user-focused 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 9951c26 commit 8b863b2

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

components/expandables.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
title: "Expandables"
33
description: "Toggle to display nested properties"
4-
icon: 'list-tree'
4+
icon: "list-tree"
55
---
66

7-
The `<Expandable>` component allows users to toggle the visibility of nested content, particularly useful for displaying complex object properties in API documentation.
7+
Use expandables to show and hide nested content within response fields. Expandables are particularly useful for displaying complex object properties in API documentation.
88

99
<ResponseField name="user" type="User Object">
1010
<Expandable title="properties">
@@ -38,12 +38,12 @@ The `<Expandable>` component allows users to toggle the visibility of nested con
3838

3939
</RequestExample>
4040

41-
## Props
41+
## Properties
4242

4343
<ResponseField name="title" type="string">
44-
The name of the object you are showing. Used to generate the "Show NAME" and "Hide NAME" text.
44+
The name of the object you are showing. Used to generate the "Show NAME" and "Hide NAME" text
4545
</ResponseField>
4646

4747
<ResponseField name="defaultOpen" type="boolean" default="false">
48-
Set to `true` to show the component as open when the page loads.
48+
Set to `true` to show the component as open when the page loads
4949
</ResponseField>

components/fields.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ description: "Set parameters for your API or SDK references"
44
icon: 'letter-text'
55
---
66

7-
Fields are used to document API parameters and responses. There are two types of fields: Parameter Fields and Response Fields.
7+
Use fields to document API parameters and responses. There are two types of fields: parameter fields and response fields.
88

9-
## Parameter Field
9+
## Parameter field
1010

1111
The `<ParamField>` component is used to define parameters for your APIs or SDKs. Adding a `ParamField` automatically adds an [API Playground](/api-playground/overview).
1212

@@ -36,7 +36,7 @@ The `<ParamField>` component is used to define parameters for your APIs or SDKs.
3636

3737
</RequestExample>
3838

39-
### Props
39+
### Properties
4040

4141
<ParamField body="query, path, body, or header" type="string">
4242
Whether it is a query, path, body, or header parameter followed by the name
@@ -74,7 +74,7 @@ The `<ParamField>` component is used to define parameters for your APIs or SDKs.
7474
Description of the parameter (markdown enabled)
7575
</ParamField>
7676

77-
## Response Field
77+
## Response field
7878

7979
The `<ResponseField>` component defines the return values of an API. Many docs also use `<ResponseField>` on pages when you need to list the types of something.
8080

@@ -88,7 +88,7 @@ The `<ResponseField>` component defines the return values of an API. Many docs a
8888
</ResponseField>
8989
```
9090

91-
### Props
91+
### Properties
9292

9393
<ResponseField name="name" type="string" required>
9494
The name of the response value

components/icons.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Use icons from popular icon libraries"
44
icon: "flag"
55
---
66

7-
The `<Icon>` component displays icons from Font Awesome, Lucide, or custom icon URLs.
7+
Use icons from Font Awesome, Lucide, or custom icon URLs to enhance your documentation.
88

99
<Icon icon="flag" size={32} />
1010

@@ -16,7 +16,7 @@ The `<Icon>` component displays icons from Font Awesome, Lucide, or custom icon
1616

1717
</RequestExample>
1818

19-
## Inline Icons
19+
## Inline icons
2020

2121
Icons are placed inline when used within a paragraph.
2222

@@ -26,7 +26,7 @@ Icons are placed inline when used within a paragraph.
2626

2727
<Icon icon="flag" iconType="solid" /> The documentation you want, effortlessly.
2828

29-
### Props
29+
### Properties
3030

3131
<ResponseField name="icon" type="string" required>
3232
A [Font Awesome](https://fontawesome.com/icons) icon, [Lucide](https://lucide.dev/icons) icon, URL to an icon, or relative path to an icon

components/steps.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: 'Sequence content using the Steps component'
44
icon: 'list-todo'
55
---
66

7-
The `<Steps>` component displays a series of sequential actions or events. You can add as many steps as needed for your workflow.
7+
Use steps to display a series of sequential actions or events. You can add as many steps as needed for your workflow.
88

99
<Steps>
1010
<Step title="First Step">
@@ -36,7 +36,7 @@ The `<Steps>` component displays a series of sequential actions or events. You c
3636

3737
</RequestExample>
3838

39-
## Steps Props
39+
## Steps properties
4040

4141
<ResponseField name="children" type="ReactElement<StepProps>[]" required>
4242
A list of `Step` components
@@ -46,7 +46,7 @@ The `<Steps>` component displays a series of sequential actions or events. You c
4646
The size of the step titles. One of `p`, `h2`, and `h3`
4747
</ResponseField>
4848

49-
## Individual Step Props
49+
## Individual step properties
5050

5151
<ResponseField name="children" type="string | ReactNode" required>
5252
The content of a step either as plain text or components

components/tabs.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Toggle content using the Tabs component"
44
icon: 'panel-top'
55
---
66

7-
The `<Tabs>` component organizes content into multiple panels that users can switch between. You can add any number of tabs and include other components inside each tab.
7+
Use tabs to organize content into multiple panels that users can switch between. You can add any number of tabs and include other components inside each tab.
88

99
<Tabs>
1010
<Tab title="First Tab">
@@ -51,7 +51,7 @@ The `<Tabs>` component organizes content into multiple panels that users can swi
5151
5252
</RequestExample>
5353
54-
## Tab Props
54+
## Properties
5555
5656
<ResponseField name="title" type="string" required>
5757
The title of the tab. Short titles are easier to navigate

0 commit comments

Comments
 (0)