Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 15 additions & 9 deletions components/accordions.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Accordions"

Check warning on line 2 in components/accordions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/accordions.mdx#L2

'title' should use sentence-style capitalization.
description: "Collapsible components to show and hide content"
icon: "chevron-down"
---
Expand Down Expand Up @@ -87,16 +87,22 @@

## Properties

<ResponseField name="title" type="string" required>
Title in the Accordion preview.
</ResponseField>
### title

<ResponseField name="description" type="string">
Detail below the title in the Accordion preview.
</ResponseField>
*Type:* `string` *Required:* Yes

Check warning on line 92 in components/accordions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/accordions.mdx#L92

': R' should be in lowercase.

<ResponseField name="defaultOpen" type="boolean" default="false">
Whether the Accordion is open by default.
</ResponseField>
Title in the Accordion preview.

### description

*Type:* `string`

Detail below the title in the Accordion preview.

### defaultOpen

Check warning on line 102 in components/accordions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/accordions.mdx#L102

Did you really mean 'defaultOpen'?

Check warning on line 102 in components/accordions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/accordions.mdx#L102

'defaultOpen' should use sentence-style capitalization.

*Type:* `boolean` *Default:* `false`

Check warning on line 104 in components/accordions.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/accordions.mdx#L104

': D' should be in lowercase.

Whether the Accordion is open by default.

<IconsOptional />
16 changes: 10 additions & 6 deletions components/banner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
icon: "layout-panel-top"
---

Use banners to display important announcements, updates, or notifications across your entire documentation site. Banners appear at the top of every page, support Markdown formatting, and can be made dismissible.

Check warning on line 7 in components/banner.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/banner.mdx#L7

In general, use active voice instead of passive voice ('be made').

To add a banner, use the `banner` property in your `docs.json`:

<CodeGroup>
```json Product announcements wrap
"banner": {
"content": "🚀 Version 2.0 is now live! See our [changelog](/changelog) for details.",

Check warning on line 14 in components/banner.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/banner.mdx#L14

'content' should use sentence-style capitalization.
"dismissible": true

Check warning on line 15 in components/banner.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/banner.mdx#L15

'dismissible' should use sentence-style capitalization.
}
```

Expand All @@ -33,10 +33,14 @@

## Properties

<ResponseField name="content" type="string" required>
The banner message. Supports plain text and Markdown formatting.
</ResponseField>
### content

<ResponseField name="dismissible" type="boolean">
Whether users can dismiss the banner. When `true`, users can close the banner and it won't reappear for their session. Defaults to `false`.
</ResponseField>
*Type:* `string` *Required:* Yes

Check warning on line 38 in components/banner.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/banner.mdx#L38

': R' should be in lowercase.

The banner message. Supports plain text and Markdown formatting.

### dismissible

*Type:* `boolean` *Default:* `false`

Check warning on line 44 in components/banner.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/banner.mdx#L44

': D' should be in lowercase.

Whether users can dismiss the banner. When `true`, users can close the banner and it won't reappear for their session.
56 changes: 35 additions & 21 deletions components/cards.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Cards"

Check warning on line 2 in components/cards.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/cards.mdx#L2

'title' should use sentence-style capitalization.
description: "Highlight main points or links with customizable layouts and icons"
icon: "square-mouse-pointer"
---
Expand Down Expand Up @@ -100,32 +100,46 @@

## Properties

<ResponseField name="title" type="string" required>
The title displayed on the card
</ResponseField>
### title

*Type:* `string` *Required:* Yes

Check warning on line 105 in components/cards.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/cards.mdx#L105

': R' should be in lowercase.

The title displayed on the card.

<IconsOptional />

<ResponseField name="color" type="string">
Icon color as a hex code (for example, `#FF6B6B`).
</ResponseField>
### color

*Type:* `string`

Icon color as a hex code (for example, `#FF6B6B`).

### href

*Type:* `string`

URL to navigate to when the card is clicked.

### horizontal

*Type:* `boolean`

Display the card in a compact horizontal layout.

### img

*Type:* `string`

URL or local path to an image displayed at the top of the card.

### cta

<ResponseField name="href" type="string">
URL to navigate to when the card is clicked.
</ResponseField>
*Type:* `string`

<ResponseField name="horizontal" type="boolean">
Display the card in a compact horizontal layout.
</ResponseField>
Custom text for the action button.

<ResponseField name="img" type="string">
URL or local path to an image displayed at the top of the card.
</ResponseField>
### arrow

<ResponseField name="cta" type="string">
Custom text for the action button.
</ResponseField>
*Type:* `boolean`

<ResponseField name="arrow" type="boolean">
Show or hide the link arrow icon.
</ResponseField>
Show or hide the link arrow icon.
16 changes: 10 additions & 6 deletions components/expandables.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Expandables"

Check warning on line 2 in components/expandables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/expandables.mdx#L2

'title' should use sentence-style capitalization.
description: "Toggle to display nested properties"
icon: "list-tree"
---
Expand Down Expand Up @@ -36,10 +36,14 @@

## Properties

<ResponseField name="title" type="string">
The name of the object you are showing.
</ResponseField>
### title

<ResponseField name="defaultOpen" type="boolean" default="false">
Set to `true` for the expandable to open when the page loads
</ResponseField>
*Type:* `string`

The name of the object you are showing.

### defaultOpen

Check warning on line 45 in components/expandables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/expandables.mdx#L45

Did you really mean 'defaultOpen'?

Check warning on line 45 in components/expandables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/expandables.mdx#L45

'defaultOpen' should use sentence-style capitalization.

*Type:* `boolean` *Default:* `false`

Check warning on line 47 in components/expandables.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/expandables.mdx#L47

': D' should be in lowercase.

Set to `true` for the expandable to open when the page loads.
114 changes: 70 additions & 44 deletions components/fields.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,53 +8,65 @@

## Parameter field

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

Check warning on line 11 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L11

In general, use active voice instead of passive voice ('is used').

<ParamField path="param" type="string" required>
An example of a parameter field
</ParamField>

```mdx
<ParamField path="param" type="string" required>

Check warning on line 18 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L18

'type' should use sentence-style capitalization.
An example of a parameter field
</ParamField>
```

### Properties

<ParamField body="query, path, body, or header" type="string">
Whether the parameter is a query, path, body, or header. Followed by the
parameter name.
</ParamField>
#### query, path, body, or header

Check warning on line 25 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L25

'query, path, body, or header' should use sentence-style capitalization.

*Type:* `string`

Whether the parameter is a query, path, body, or header. Followed by the parameter name.

<ParamField body="type" type="string">
Expected type of the parameter's value.
#### type

Check warning on line 31 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L31

'type' should use sentence-style capitalization.

*Type:* `string`

Expected type of the parameter's value.

Supports `number`, `string`, `boolean`, `object`.
Supports `number`, `string`, `boolean`, `object`.

Arrays can be defined using the `[]` suffix. For example `string[]`.

Check warning on line 39 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L39

In general, use active voice instead of passive voice ('be defined').

</ParamField>
#### required

<ParamField body="required" type="boolean">
Indicate whether the parameter is required.
</ParamField>
*Type:* `boolean`

<ParamField body="deprecated" type="boolean">
Indicate whether the parameter is deprecated.
</ParamField>
Indicate whether the parameter is required.

Check warning on line 45 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L45

In general, use active voice instead of passive voice ('is required').

<ParamField body="default" type="any">
Default value populated when the request value is empty
</ParamField>
#### deprecated

Check warning on line 47 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L47

'deprecated' should use sentence-style capitalization.

<ParamField body="placeholder" type="string">
Placeholder text for the input in the playground.
</ParamField>
*Type:* `boolean`

<ParamField body="children" type="string">
Description of the parameter (Markdown-enabled).
</ParamField>
Indicate whether the parameter is deprecated.

Check warning on line 51 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L51

In general, use active voice instead of passive voice ('is deprecated').

#### default

Check warning on line 53 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L53

'default' should use sentence-style capitalization.

*Type:* `any`

Default value populated when the request value is empty.

#### placeholder

Check warning on line 59 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L59

'placeholder' should use sentence-style capitalization.

*Type:* `string`

Placeholder text for the input in the playground.

#### children

Check warning on line 65 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L65

'children' should use sentence-style capitalization.

*Type:* `string`

Description of the parameter (Markdown-enabled).

Check warning on line 69 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L69

Use parentheses judiciously.

## Response field

Expand All @@ -65,37 +77,51 @@
</ResponseField>

```mdx
<ResponseField name="response" type="string" required>

Check warning on line 80 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L80

'name' should use sentence-style capitalization.
A response field example
</ResponseField>
```

### Properties

<ResponseField name="name" type="string" required>
The name of the response value.
</ResponseField>
#### name

<ResponseField name="type" type="string" required>
Expected type of the response value. This can be any arbitrary string.
</ResponseField>
*Type:* `string` *Required:* Yes

Check warning on line 89 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L89

': R' should be in lowercase.

<ResponseField name="default" type="string">
The default value.
</ResponseField>
The name of the response value.

<ResponseField name="required" type="boolean">
Indicate whether the response is required.
</ResponseField>
#### type

<ResponseField name="deprecated" type="boolean">
Whether a field is deprecated.
</ResponseField>
*Type:* `string` *Required:* Yes

Check warning on line 95 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L95

': R' should be in lowercase.

<ResponseField name="pre" type="string[]">
Labels that are shown before the name of the field.
</ResponseField>
Expected type of the response value. This can be any arbitrary string.

<ResponseField name="post" type="string[]">
Labels that are shown after the name of the field.
</ResponseField>
#### default

Check warning on line 99 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L99

'default' should use sentence-style capitalization.

*Type:* `string`

The default value.

#### required

*Type:* `boolean`

Indicate whether the response is required.

Check warning on line 109 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L109

In general, use active voice instead of passive voice ('is required').

#### deprecated

Check warning on line 111 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L111

'deprecated' should use sentence-style capitalization.

*Type:* `boolean`

Whether a field is deprecated.

Check warning on line 115 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L115

In general, use active voice instead of passive voice ('is deprecated').

#### pre

Check warning on line 117 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L117

Did you really mean 'pre'?

Check warning on line 117 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L117

'pre' should use sentence-style capitalization.

*Type:* `string[]`

Labels that are shown before the name of the field.

Check warning on line 121 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L121

In general, use active voice instead of passive voice ('are shown').

#### post

Check warning on line 123 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L123

'post' should use sentence-style capitalization.

*Type:* `string[]`

Labels that are shown after the name of the field.

Check warning on line 127 in components/fields.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/fields.mdx#L127

In general, use active voice instead of passive voice ('are shown').
8 changes: 5 additions & 3 deletions components/frames.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@

## Properties

<ResponseField name="caption" type="string">
Optional caption text to show centered under your component.
</ResponseField>
### caption

Check warning on line 23 in components/frames.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/frames.mdx#L23

'caption' should use sentence-style capitalization.

*Type:* `string`

Optional caption text to show centered under your component.

<CodeGroup>

Expand Down
16 changes: 10 additions & 6 deletions components/icons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

Use icons from Font Awesome, Lucide, SVGs, external URLs, or files in your project to enhance your documentation.

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

Check warning on line 11 in components/icons.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/icons.mdx#L11

'size' should use sentence-style capitalization.

```mdx Icon example
<Icon icon="flag" size={32} />
Expand All @@ -16,7 +16,7 @@

## Inline icons

Icons are placed inline when used within a paragraph.

Check warning on line 19 in components/icons.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/icons.mdx#L19

In general, use active voice instead of passive voice ('are placed').

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

Expand All @@ -28,10 +28,14 @@

<IconsRequired />

<ResponseField name="color" type="string">
The color of the icon as a hex code (for example, `#FF5733`).
</ResponseField>
### color

Check warning on line 31 in components/icons.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/icons.mdx#L31

'color' should use sentence-style capitalization.

<ResponseField name="size" type="number">
The size of the icon in pixels.
</ResponseField>
*Type:* `string`

The color of the icon as a hex code (for example, `#FF5733`).

Check warning on line 35 in components/icons.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/icons.mdx#L35

Use parentheses judiciously.

### size

*Type:* `number`

The size of the icon in pixels.
48 changes: 30 additions & 18 deletions components/steps.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Steps"

Check warning on line 2 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L2

'title' should use sentence-style capitalization.
description: "Sequence content using the Steps component"
icon: "list-todo"
---
Expand Down Expand Up @@ -36,30 +36,42 @@

## Steps properties

<ResponseField name="children" type="ReactElement<StepProps>[]" required>
A list of `Step` components.
</ResponseField>
### children

Check warning on line 39 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L39

'children' should use sentence-style capitalization.

<ResponseField name="titleSize" type="string" default="p">
The size of the step titles. One of `p`, `h2`, and `h3`.
</ResponseField>
*Type:* `ReactElement<StepProps>[]` *Required:* Yes

Check warning on line 41 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L41

': R' should be in lowercase.

A list of `Step` components.

### titleSize

Check warning on line 45 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L45

Did you really mean 'titleSize'?

Check warning on line 45 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L45

'titleSize' should use sentence-style capitalization.

*Type:* `string` *Default:* `p`

Check warning on line 47 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L47

': D' should be in lowercase.

The size of the step titles. One of `p`, `h2`, and `h3`.

## Individual step properties

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

Check warning on line 53 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L53

'children' should use sentence-style capitalization.

*Type:* `string | ReactNode` *Required:* Yes

Check warning on line 55 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L55

': R' should be in lowercase.

The content of a step either as plain text or components.

<IconsOptional />

<ResponseField name="title" type="string">
The title is the primary text for the step and shows up next to the indicator.
</ResponseField>
### title

*Type:* `string`

The title is the primary text for the step and shows up next to the indicator.

### stepNumber

Check warning on line 67 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L67

Did you really mean 'stepNumber'?

Check warning on line 67 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L67

'stepNumber' should use sentence-style capitalization.

*Type:* `number`

The number of the step.

### titleSize

Check warning on line 73 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L73

Did you really mean 'titleSize'?

Check warning on line 73 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L73

'titleSize' should use sentence-style capitalization.

<ResponseField name="stepNumber" type="number">
The number of the step.
</ResponseField>
*Type:* `string` *Default:* `p`

Check warning on line 75 in components/steps.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/steps.mdx#L75

': D' should be in lowercase.

<ResponseField name="titleSize" type="string" default="p">
The size of the step titles. One of `p`, `h2`, and `h3`.
</ResponseField>
The size of the step titles. One of `p`, `h2`, and `h3`.
Loading