Skip to content
Merged
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
4 changes: 2 additions & 2 deletions api-playground/mdx-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
keywords: ["API documentation", "endpoint documentation"]
---

You can manually define API endpoints in individual pages. This approach is useful for small APIs or prototyping.
You can manually define API endpoints in individual MDX pages. This approach is useful for small APIs or prototyping.

## Setup

Expand Down Expand Up @@ -38,7 +38,7 @@
</Step>

<Step title="Create your endpoint pages">
Create an `MDX` file for each endpoint. Define the `title` and `api` in the frontmatter:
Create an MDX file for each endpoint. Define the `title` and `api` in the frontmatter:

```mdx
---
Expand Down Expand Up @@ -175,7 +175,7 @@

### None

To disable authentication on a specific page, set `authMethod` to `none`:

Check warning on line 178 in api-playground/mdx-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/mdx-setup.mdx#L178

Use 'turn off' or 'off' instead of 'disable'.

```mdx Page Metadata
---
Expand Down
4 changes: 2 additions & 2 deletions api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

The playground generates interactive pages for your endpoints based on your OpenAPI specification or AsyncAPI schema. If you modify your API, the playground automatically updates the relevant pages.

We recommend generating your API playground from an OpenAPI specification. However, you can manually create API reference pages after defining a base URL and authentication method in your `docs.json`.

Check warning on line 20 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L20

Try to avoid using first-person plural like 'We'.

## Get started

Expand Down Expand Up @@ -83,7 +83,7 @@
<Expandable title="playground" defaultOpen="True">
<ResponseField name="display" type="&quot;interactive&quot; | &quot;simple&quot; | &quot;none&quot;">
The display mode of the API playground.
- `"interactive"`: Display the interactive playground.

Check warning on line 86 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L86

': D' should be in lowercase.
- `"simple"`: Display a copyable endpoint with no playground.
- `"none"`: Display nothing.

Expand Down Expand Up @@ -114,7 +114,7 @@

### Example configuration

This example configures the API playground to be interactive with example code snippets for cURL, Python, and JavaScript. Only required parameters are shown in the code snippets, and the playground prefills the request body with example values.

Check warning on line 117 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L117

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

Check warning on line 117 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L117

Did you really mean 'prefills'?

```json
{
Expand All @@ -133,7 +133,7 @@

### Custom endpoint pages

When you need more control over your API documentation, use the `x-mint` extension in your OpenAPI specification or create individual `MDX` pages for your endpoints.
When you need more control over your API documentation, use the `x-mint` extension in your OpenAPI specification or create individual MDX pages for your endpoints.

Both options allow you to:

Expand All @@ -143,7 +143,7 @@

The `x-mint` extension is recommended so that all of your API documentation is automatically generated from your OpenAPI specification and maintained in one file.

Individual `MDX` pages are recommended for small APIs or when you want to experiment with changes on a per-page basis.
Individual MDX pages are recommended for small APIs or when you want to experiment with changes on a per-page basis.

## Further reading

Expand Down
2 changes: 1 addition & 1 deletion customize/custom-scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Use CSS to style HTML elements or add custom CSS and JavaScript to fully customize the look and feel of your documentation.

## Styling with Tailwind CSS

Check warning on line 9 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L9

'Styling with Tailwind CSS' should use sentence-style capitalization.

Use Tailwind CSS v3 to style HTML elements. You can control layout, spacing, colors, and other visual properties. Some common classes are:

Expand All @@ -16,15 +16,15 @@
- `block`, `hidden` - Display control
- `dark:hidden`, `dark:block` - Dark mode visibility

Tailwind CSS arbitrary values are not supported. For custom values, use the `style` prop instead.

Check warning on line 19 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L19

Use 'aren't' instead of 'are not'.

```html
<img style={{ width: '350px', margin: '12px auto' }} src="/path/image.jpg" />
```

## Custom CSS

Check warning on line 25 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L25

'Custom CSS' should use sentence-style capitalization.

Add CSS files to your repository and their defined class names will be applied and available in all of your `MDX` files.
Add CSS files to your repository and their defined class names will be applied and available in all of your MDX files.

Check warning on line 27 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L27

Avoid using 'will'.

Check warning on line 27 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L27

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

### Adding `style.css`

Expand Down Expand Up @@ -160,11 +160,11 @@

## Custom JavaScript

Custom JS allows you to add custom executable code globally. It is the equivalent of adding a `<script>` tag with JS code into every page.

Check warning on line 163 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L163

Use 'it's' instead of 'It is'.

### Adding custom JavaScript

Any `.js` file inside the content directory of your docs will be included in every documentation page. For example, you can add the following `ga.js` file to enable [Google Analytics](https://marketingplatform.google.com/about/analytics) across the entire documentation.

Check warning on line 167 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L167

Avoid using 'will'.

Check warning on line 167 in customize/custom-scripts.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-scripts.mdx#L167

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

```js
window.dataLayer = window.dataLayer || [];
Expand Down
8 changes: 4 additions & 4 deletions customize/react-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## Using React components

You can build React components directly in your `MDX` files using [React hooks](https://react.dev/reference/react/hooks).
You can build React components directly in your MDX files using [React hooks](https://react.dev/reference/react/hooks).

### Example

Expand Down Expand Up @@ -92,11 +92,11 @@

## Importing components

To import React components in your `MDX` files, the component files must be located in the `snippets` folder. You can then import them into any `MDX` page in your documentation. Learn more about [reusable snippets](/create/reusable-snippets).
To import React components in your MDX files, the component files must be located in the `snippets` folder. You can then import them into any MDX page in your documentation. Learn more about [reusable snippets](/create/reusable-snippets).

### Example

This example declares a `ColorGenerator` component that uses multiple React hooks and then uses it in an `MDX` file.
This example declares a `ColorGenerator` component that uses multiple React hooks and then uses it in an MDX file.

Create `color-generator.jsx` file in the `snippets` folder:

Expand Down Expand Up @@ -213,7 +213,7 @@
}
```

Import the `ColorGenerator` component and use it in an `MDX` file:
Import the `ColorGenerator` component and use it in an MDX file:

```mdx
import { ColorGenerator } from "/snippets/color-generator.jsx"
Expand All @@ -236,9 +236,9 @@
- **Accessibility**: Ensure dynamic content changes are announced to screen readers.
</Accordion>
<Accordion title="Performance best practices">
- **Optimize dependency arrays**: Include only necessary dependencies in your `useEffect` dependency arrays.

Check warning on line 239 in customize/react-components.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/react-components.mdx#L239

': I' should be in lowercase.
- **Memoize complex calculations**: Use `useMemo` or `useCallback` for expensive operations.

Check warning on line 240 in customize/react-components.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/react-components.mdx#L240

': U' should be in lowercase.
- **Reduce re-renders**: Break large components into smaller ones to prevent cascading re-renders.

Check warning on line 241 in customize/react-components.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/react-components.mdx#L241

': B' should be in lowercase.
- **Lazy loading**: Consider lazy loading complex components to improve initial page load time.

Check warning on line 242 in customize/react-components.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/react-components.mdx#L242

': C' should be in lowercase.
</Accordion>
</AccordionGroup>
4 changes: 2 additions & 2 deletions deploy/personalization-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
keywords: ["content personalization", "user data", "prefilling", "dynamic"]
---

Personalization customizes your documentation for each user when they are logged in. For example, you can prefill their API keys, show content specific to their plan or role, or hide sections they don't need access to.

Check warning on line 7 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L7

Use 'they're' instead of 'they are'.

Check warning on line 7 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L7

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

## Personalization features

Expand All @@ -28,7 +28,7 @@

Restrict which pages are visible to your users by adding `groups` fields to your pages' frontmatter. By default, every page is visible to every user.

Users will only see pages for `groups` that they are in.

Check warning on line 31 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L31

Avoid using 'will'.

Check warning on line 31 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L31

Use 'they're' instead of 'they are'.

```mdx
---
Expand All @@ -40,7 +40,7 @@

## User data format

When implementing personalization, your system returns user data in a specific format that enables content customization. This data can be sent as either a raw JSON object or within a signed JWT, depending on your handshake method. The shape of the data is the same for both.

Check warning on line 43 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L43

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

Check warning on line 43 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L43

Spell out 'JWT', if it's unfamiliar to the audience.

```tsx
type User = {
Expand All @@ -61,7 +61,7 @@
type="number"
>
Session expiration time in **seconds since epoch**. If the user loads a page after this time, their stored data is automatically deleted and they must reauthenticate.
<Warning><b>For JWT handshakes:</b> This differs from the JWT's `exp` claim, which determines when a JWT is considered invalid. Set the JWT `exp` claim to a short duration (10 seconds or less) for security. Use `expiresAt` for the actual session length (hours to weeks).</Warning>

Check warning on line 64 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L64

Spell out 'JWT', if it's unfamiliar to the audience.

Check warning on line 64 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L64

Spell out 'JWT', if it's unfamiliar to the audience.

Check warning on line 64 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L64

Spell out 'JWT', if it's unfamiliar to the audience.

Check warning on line 64 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L64

In general, use active voice instead of passive voice ('is considered').
</ParamField>
<ParamField
path="groups"
Expand All @@ -69,24 +69,24 @@
>
List of groups the user belongs to. Pages with matching `groups` in their frontmatter are visible to this user.

**Example**: User with `groups: ["admin", "engineering"]` can access pages tagged with either the `admin` or `engineering` groups.

Check warning on line 72 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L72

': U' should be in lowercase.
</ParamField>
<ParamField
path="content"
type="object"
>
Custom data accessible in your `MDX` content via the `user` variable. Use this for dynamic personalization throughout your documentation.
Custom data accessible in your MDX content via the `user` variable. Use this for dynamic personalization throughout your documentation.

**Basic example**:
```json
{ "firstName": "Ronan", "company": "Acme Corp", "plan": "Enterprise" }
```

**Usage in `MDX`**:
**Usage in MDX**:
```mdx
Welcome back, {user.firstName}! Your {user.plan} plan includes...
```
With the example `user` data, this would render as: Welcome back, Ronan! Your Enterprise plan includes...

Check warning on line 89 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L89

': W' should be in lowercase.

Check warning on line 89 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L89

In general, don't use an ellipsis.

**Advanced conditional rendering**:
```jsx
Expand Down Expand Up @@ -117,7 +117,7 @@
"query": { "org_id": "12345" }
}
```
If a user makes requests at a specific subdomain, you can send `{ server: { subdomain: 'foo' } }` as an `apiPlaygroundInputs` field. This value will be prefilled on any API page with the `subdomain` value.

Check warning on line 120 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L120

Avoid using 'will'.

<Note>The `header`, `query`, and `cookie` fields will only prefill if they are part of your [OpenAPI security scheme](https://swagger.io/docs/specification/authentication/). If a field is in either the `Authorization` or `Server` sections, it will prefill. Creating a standard header parameter named `Authorization` will not enable this feature.</Note>
</ParamField>
Expand Down Expand Up @@ -173,7 +173,7 @@
<Step title="Integrate Mintlify personalization into your login flow.">
Modify your existing login flow to include these steps after user login:

* Create a JWT containing the logged-in user's info in the `User` format. See the [User data format](#user-data-format) section above for more information.

Check warning on line 176 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L176

Use 'preceding' instead of 'above'.
* Sign the JWT with the secret key, using the ES256 algorithm.
* Create a redirect URL back to your docs, including the JWT as the hash.
</Step>
Expand All @@ -181,7 +181,7 @@

### Example

Your documentation is hosted at `docs.foo.com`. You want your docs to be separate from your dashboard (or you don't have a dashboard) and enable personalization.

Check warning on line 184 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L184

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

Generate a JWT secret. Then create a login endpoint at `https://foo.com/docs-login` that initiates a login flow to your documentation.

Expand Down Expand Up @@ -227,7 +227,7 @@
</Tab>
<Tab title="OAuth 2.0">
### Prerequisites
* An OAuth server that supports the Auth Code with PKCE Flow

Check warning on line 230 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L230

Spell out 'PKCE', if it's unfamiliar to the audience.
* Ability to create an API endpoint accessible by OAuth access tokens

### Implementation
Expand All @@ -242,11 +242,11 @@
1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication).
2. Select **Personalization**.
3. Select **OAuth** and configure these fields:
* **Authorization URL**: Your OAuth authorization endpoint.

Check warning on line 245 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L245

': Y' should be in lowercase.
* **Client ID**: Your OAuth 2.0 client identifier.
* **Scopes**: Permissions to request. Copy the **entire** scope string (for example, for a scope like `provider.users.docs`, copy the complete `provider.users.docs`). Must match the scopes of the endpoint that you configured in the first step.

Check warning on line 247 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L247

Use parentheses judiciously.

Check warning on line 247 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L247

': P' should be in lowercase.
* **Token URL**: Your OAuth token exchange endpoint.
* **Info API URL**: Endpoint to retrieve user data for personalization. Created in the first step.

Check warning on line 249 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L249

': E' should be in lowercase.
4. Select **Save changes**
</Step>
<Step title="Configure your OAuth server.">
Expand All @@ -257,7 +257,7 @@

### Example

Your documentation is hosted at `foo.com/docs` and you have an existing OAuth server that supports the PKCE flow. You want to personalize your docs based on user data.

Check warning on line 260 in deploy/personalization-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/personalization-setup.mdx#L260

Spell out 'PKCE', if it's unfamiliar to the audience.

**Create a user info endpoint** at `api.foo.com/docs/user-info`, which requires an OAuth access token with the `provider.users.docs` scope and responds with the user's custom data:

Expand Down
12 changes: 5 additions & 7 deletions editor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@

### Markdown mode

Markdown mode provides direct access to the underlying `MDX` code of your documentation. This mode is ideal for when you need precise control over component properties or when you prefer to write in Markdown syntax.
Markdown mode provides direct access to the files that make up your documentation. This mode is ideal for when you need precise control over component properties or when you prefer to write in MDX syntax.

<Frame>
<img
Expand Down Expand Up @@ -224,9 +224,7 @@

Make changes to your pages using visual mode or Markdown mode in the editor.

In visual mode, press <kbd>/</kbd>

to open the component menu. Add content blocks, callouts, code blocks, and other components to customize your documentation.
In visual mode, press <kbd>/</kbd> to open the component menu. Add content blocks, callouts, code blocks, and other components to customize your documentation.

<Frame>
<img
Expand All @@ -242,13 +240,13 @@
/>
</Frame>

In Markdown mode, you directly edit the `MDX` of your pages. This can be helpful when you need to:
In Markdown mode, you can directly edit the MDX of your pages. This can be helpful when you need to:

- Set specific component properties
- Work with complex nested components
- Copy and paste `MDX` content from other sources
- Copy and paste MDX content from other sources

See [Format text](/create/text) and [Format code](/create/code) for more information on how to write using Markdown syntax.
See [Format text](/create/text) and [Format code](/create/code) for more information on how to write using MDX syntax.

## Publish your changes

Expand All @@ -271,7 +269,7 @@
/>
</Frame>

If you authorize Mintlify to your GitHub user, your commits will be signed as if you had made them yourself. If not, they will be signed by the Mintlify GitHub app.

Check warning on line 272 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L272

Avoid using 'will'.

Check warning on line 272 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L272

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

Check warning on line 272 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L272

Avoid using 'will'.

Check warning on line 272 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L272

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

### Pull requests and reviewing changes

Expand All @@ -298,7 +296,7 @@
- Any specific areas that need review
</Step>
<Step title="Create and share">
Select **Publish Pull Request**. The editor will provide a link to view your pull request.

Check warning on line 299 in editor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor.mdx#L299

Avoid using 'will'.

<Frame>
<img
Expand Down
10 changes: 5 additions & 5 deletions guides/migrating-from-mdx.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: "Migrating MDX API pages to OpenAPI navigation"
sidebarTitle: "Migrate from MDX to OAS"

Check warning on line 3 in guides/migrating-from-mdx.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/migrating-from-mdx.mdx#L3

Spell out 'OAS', if it's unfamiliar to the audience.
description: "Migrate to automated OpenAPI generation with flexible navigation."
keywords: ["API migration", "mint migrate-mdx", "OpenAPI migration", "x-mint extension"]
---

If you are currently using individual `MDX` pages for your API endpoints, you can migrate to autogenerating pages from your OpenAPI specification while retaining the customizability of individual pages. This can help you reduce the number of files you need to maintain and improve the consistency of your API documentation.
If you are currently using individual MDX pages for your API endpoints, you can migrate to autogenerating pages from your OpenAPI specification while retaining the customizability of individual pages. This can help you reduce the number of files you need to maintain and improve the consistency of your API documentation.

You can define metadata and content for each endpoint in your OpenAPI specification and organize endpoints where you want them in your navigation.

## CLI migration

Check warning on line 12 in guides/migrating-from-mdx.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/migrating-from-mdx.mdx#L12

Use 'command-line tool' instead of 'CLI'.

The `mint migrate-mdx` command is the recommended way to migrate from MDX endpoint pages to autogenerated pages.

Expand All @@ -21,11 +21,11 @@
- Deletes the original MDX endpoint files.

<Info>
If you already have `x-mint` defined for an endpoint and also have an MDX page with content for that endpoint, the MDX content will overwrite existing `x-mint` settings.

Check warning on line 24 in guides/migrating-from-mdx.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/migrating-from-mdx.mdx#L24

Avoid using 'will'.

If you have multiple MDX pages for the same endpoint with different content, the script will use the content from the page that appears last in your `docs.json`.

Check warning on line 26 in guides/migrating-from-mdx.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/migrating-from-mdx.mdx#L26

Avoid using 'will'.

The migration tool does not support previewing changes before applying them.

Check warning on line 28 in guides/migrating-from-mdx.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/migrating-from-mdx.mdx#L28

Use 'doesn't' instead of 'does not'.
</Info>

<Steps>
Expand All @@ -39,7 +39,7 @@
</Tip>
</Step>
<Step title="Install the Mint CLI">
If needed, install or update the [Mint CLI](/installation).

Check warning on line 42 in guides/migrating-from-mdx.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/migrating-from-mdx.mdx#L42

Use the Oxford comma in 'If needed, install or'.
</Step>
<Step title="Run the migration command.">
```bash
Expand All @@ -64,7 +64,7 @@
</Step>

<Step title="Update your navigation structure.">
Replace `MDX` page references with OpenAPI endpoints in your `docs.json`.
Replace MDX page references with OpenAPI endpoints in your `docs.json`.

```json
"navigation": {
Expand All @@ -90,7 +90,7 @@
</Step>

<Step title="Remove old MDX files.">
After verifying your new navigation works correctly, remove the `MDX` endpoint files that you no longer need.
After verifying your new navigation works correctly, remove the MDX endpoint files that you no longer need.
</Step>
</Steps>

Expand Down Expand Up @@ -138,9 +138,9 @@
}
```

## When to use individual `MDX` pages
## When to use individual MDX pages

Consider keeping individual `MDX` pages when you need:
Consider keeping individual MDX pages when you need:

- Extensive custom content per endpoint like React components or lengthy examples.
- Unique page layouts.
Expand Down
2 changes: 1 addition & 1 deletion installation.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "CLI installation"

Check warning on line 2 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L2

Use 'command-line tool' instead of 'CLI'.
description: "Use the CLI to preview docs locally, test changes in real-time, and catch issues before deploying your documentation site."
keywords: ["CLI", "npm", "local development", "Node.js"]

Check warning on line 4 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L4

Use 'command-line tool' instead of 'CLI'.
---

<img
Expand All @@ -15,14 +15,14 @@
alt="Decorative graphic representing the CLI."
/>

Use the CLI to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and functionality, and catch issues like broken links or accessibility problems.

Check warning on line 18 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L18

Use 'capability' or 'feature' instead of 'functionality'.

The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats.

Check warning on line 20 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L20

Use 'command-line tool' instead of 'CLI'.

## Install the CLI

<Info>
**Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher through v24. LTS versions are preferred.

Check warning on line 25 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L25

': T' should be in lowercase.

Check warning on line 25 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L25

Spell out 'LTS', if it's unfamiliar to the audience.

Check warning on line 25 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L25

In general, use active voice instead of passive voice ('are preferred').
</Info>

Run the following command to install the [CLI](https://www.npmjs.com/package/mint):
Expand All @@ -39,7 +39,7 @@

## Preview locally

To generate a local preview, navigate to your documentation directory (where your `docs.json` file is located) and run the following command:

Check warning on line 42 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L42

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

```bash
mint dev
Expand All @@ -47,7 +47,7 @@

A local preview of your documentation is available at `http://localhost:3000`.

Alternatively, if you do not want to install the CLI globally, you can run a one-time script:

Check warning on line 50 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L50

Use 'don't' instead of 'do not'.

Check warning on line 50 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L50

Use 'command-line tool' instead of 'CLI'.

```bash
npx mint dev
Expand All @@ -55,13 +55,13 @@

### Custom ports

By default, the CLI uses port 3000. You can customize the port using the `--port` flag. To run the CLI on port 3333, for instance, use this command:

Check warning on line 58 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L58

Use 'command-line tool' instead of 'CLI'.

Check warning on line 58 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L58

Use 'command-line tool' instead of 'CLI'.

```bash
mint dev --port 3333
```

If you attempt to run on a port that is already in use, it will use the next available port:

Check warning on line 64 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L64

Use 'that's' instead of 'that is'.

Check warning on line 64 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L64

Avoid using 'will'.

```mdx
Port 3000 is already in use. Trying 3001 instead.
Expand All @@ -85,13 +85,13 @@
mint new [directory]
```

This command clones the [starter kit](https://github.com/mintlify/starter) into a specified directory. If no directory is specified, the CLI tool prompts you to create a new subdirectory or overwrite the current directory.

Check warning on line 88 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L88

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

Check warning on line 88 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L88

Use 'command-line tool' instead of 'CLI'.

<Warning>
If you overwrite the current directory, any existing files in the directory will be deleted.

Check warning on line 91 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L91

Avoid using 'will'.

Check warning on line 91 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L91

In general, use active voice instead of passive voice ('be deleted').
</Warning>

The CLI tool prompts you for a project name and [theme](/customize/themes) to finish setting up your project.

Check warning on line 94 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L94

Use 'command-line tool' instead of 'CLI'.

You can run `mint new` with the following flags:

Expand All @@ -104,15 +104,15 @@
```bash
mint new docs --name my-project --theme linden
```
## Update the CLI

Check warning on line 107 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L107

Use 'command-line tool' instead of 'CLI'.

If your local preview is out of sync with what you see on the web in the production version, update your local CLI:

Check warning on line 109 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L109

Use 'command-line tool' instead of 'CLI'.

```bash
mint update
```

If this `mint update` command is not available on your local version, re-install the CLI with the latest version:

Check warning on line 115 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L115

Use 'isn't' instead of 'is not'.

Check warning on line 115 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L115

Use 'command-line tool' instead of 'CLI'.

<CodeGroup>
```bash npm
Expand Down Expand Up @@ -150,7 +150,7 @@
mint openapi-check <OpenAPI filename or URL>
```

Pass a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).

Check warning on line 153 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L153

Use parentheses judiciously.

### Rename files

Expand All @@ -172,11 +172,11 @@

## Formatting

While developing locally, we recommend using extensions in your IDE to recognize and format `MDX` files.
While developing locally, we recommend using extensions in your IDE to recognize and format MDX files.

Check warning on line 175 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L175

Try to avoid using first-person plural like 'we'.

If you use Cursor, Windsurf, or VS Code, we recommend the [MDX VS Code extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.

Check warning on line 177 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L177

Try to avoid using first-person plural like 'we'.

If you use JetBrains, we recommend the [MDX IntelliJ IDEA plugin](https://plugins.jetbrains.com/plugin/14944-mdx) for syntax highlighting, and setting up [Prettier](https://prettier.io/docs/webstorm) for code formatting.

Check warning on line 179 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L179

Try to avoid using first-person plural like 'we'.

## Troubleshooting

Expand All @@ -189,7 +189,7 @@
3. Reinstall the mint CLI: `npm install -g mint`
</Accordion>
<Accordion title="Issue: Encountering an unknown error">
**Solution**: Go to the root of your device and delete the `~/.mintlify` folder. Afterwards, run `mint dev` again.

Check warning on line 192 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L192

': G' should be in lowercase.
</Accordion>
<Accordion title="Error: permission denied">
This is due to not having the required permissions to globally install node packages.
Expand All @@ -197,12 +197,12 @@
**Solution**: Try running `sudo npm i -g mint`. You will be prompted for your password, which is the one you use to unlock your computer.
</Accordion>
<Accordion title="The local preview doesn't look the same as my docs do on the web">
This is likely due to an outdated version of the CLI.

Check warning on line 200 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L200

Use 'command-line tool' instead of 'CLI'.

**Solution:** Run `mint update` to get the latest changes.

Check warning on line 202 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L202

': R' should be in lowercase.
</Accordion>
<Accordion title="mintlify vs. mint package">
If you have any problems with the CLI package, you should first run `npm ls -g`. This command shows what packages are globally installed on your machine.

Check warning on line 205 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L205

Use 'command-line tool' instead of 'CLI'.

If you don't use npm or don't see it in the -g list, try `which mint` to locate the installation.

Expand Down
12 changes: 8 additions & 4 deletions migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@

<CardGroup cols="2">
<Card title="Automated migration" icon="wand-sparkles">
If you are migrating from Docusaurus or ReadMe, use our tools to automate your migration.

Check warning on line 13 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L13

Try to avoid using first-person plural like 'our'.
</Card>

<Card title="Manual migration" icon="pencil-ruler">
If you are migrating from any other platform, follow our guide to migrate your content.

Check warning on line 17 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L17

Try to avoid using first-person plural like 'our'.
</Card>
</CardGroup>

Expand Down Expand Up @@ -101,7 +101,7 @@
</svg>} horizontal />
</Columns>

If your documentation is hosted on another platform, see the manual migration steps.

Check warning on line 104 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L104

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

### Installing the scraper

Expand All @@ -113,7 +113,7 @@

### Scraping pages and sections

The migration tool automatically detects your documentation platform and converts your content. Prepared files are stored locally in `./docs` by default.

Check warning on line 116 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L116

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

For large documentation sites, migrate smaller sections at a time rather than the entire site at once.

Expand All @@ -136,7 +136,7 @@

After scraping your existing documentation platform, you are ready to build your docs on Mintlify.

Confirm that all of your pages have been migrated then add these files to the documentation repository that you created during the onboarding process. This is usually a GitHub repository.

Check warning on line 139 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L139

In general, use active voice instead of passive voice ('been migrated').
</Tab>
<Tab title="Manual migration">

Expand All @@ -144,20 +144,24 @@

### Content migration

To migrate your content to Mintlify, you will need:

Check warning on line 147 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L147

Avoid using 'will'.

- A valid `docs.json` for your site settings and navigation. See [Global settings](/organize/settings) and [Navigation](/organize/navigation) for more information.
- An `MDX` file for each page of your documentation. See [Pages](/organize/pages) for more information.
- A Markdown file (`.md` or `.mdx`) for each page of your documentation. MDX is the recommended format. See [Pages](/organize/pages) for more information.

Check warning on line 150 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L150

Use parentheses judiciously.
- (Optional) An OpenAPI specification for your API endpoint pages. See [OpenAPI setup](/api-playground/openapi-setup) for more information.

Check warning on line 151 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L151

Use parentheses judiciously.

1. If your content is already in `MDX` format, copy the pages to your Mintlify project. Otherwise, convert your content to `MDX` format.
2. Create your `docs.json` referencing the paths to your `MDX` pages.
1. If your content is already in Markdown format, copy the content to your Mintlify project. Otherwise, convert your content to MDX format.
2. Create your `docs.json` referencing the paths to your Markdown pages.
3. If you have OpenAPI specifications, add them to your `docs.json` and configure the API playground.

<Tip>
If you migrate your content as `.md` files, convert them to `.mdx` to support interactive features like React components.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

love this ❤️

</Tip>

### Asset migration

1. Copy assets to your repository's `images/` directory.
2. Update references in your `MDX` files:
2. Update references in your Markdown files:
```mdx
![Alt text](/images/screenshot.png)
```
Expand All @@ -167,13 +171,13 @@

## Post-migration checklist

After completing your migration (automated or manual), we recommend checking:

Check warning on line 174 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L174

Use parentheses judiciously.

Check warning on line 174 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L174

Try to avoid using first-person plural like 'we'.

- All pages render
- Navigation works as intended
- Internal links resolve properly
- Images and assets load correctly
- Code blocks display with proper syntax highlighting
- Search functionality works

Check warning on line 181 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L181

Use 'capability' or 'feature' instead of 'functionality'.
- Deployment is configured

Check warning on line 182 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L182

In general, use active voice instead of passive voice ('is configured').
- Custom domain is set up

Check warning on line 183 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L183

In general, use active voice instead of passive voice ('is set').
2 changes: 1 addition & 1 deletion organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## Pages

Pages are the most fundamental navigation component. Pages map to the MDX files that make up your documentation.
Pages are the most fundamental navigation component. Each page is an MDX file in your documentation repository.

<img
className="block dark:hidden pointer-events-none"
Expand Down Expand Up @@ -96,8 +96,8 @@

Use the `expanded` property to control the default state of a group in the navigation sidebar.

- `expanded: true`: Group is expanded by default.

Check warning on line 99 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L99

In general, use active voice instead of passive voice ('is expanded').
- `expanded: false` or omitted: Group is collapsed by default.

Check warning on line 100 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L100

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

This is useful for highlighting important sections or improving discoverability of key content.

Expand Down Expand Up @@ -254,9 +254,9 @@
}
```

For anchors that direct to external links only, use the `global` keyword. Anchors in a `global` object must have an `href` field and cannot point to a relative path.

Check warning on line 257 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L257

Use 'can't' instead of 'cannot'.

Global anchors are particularly useful for linking to resources that are not part of your documentation, but should be readily accessible to your users like a blog or support portal.

Check warning on line 259 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L259

Use 'aren't' instead of 'are not'.

```json
{
Expand All @@ -282,7 +282,7 @@

## Dropdowns

Dropdowns are contained in an expandable menu at the top of your sidebar navigation. Each item in a dropdown directs to a section of your documentation.

Check warning on line 285 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L285

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

<img
className="block dark:hidden pointer-events-none"
Expand Down Expand Up @@ -397,7 +397,7 @@

Integrate OpenAPI specifications directly into your navigation structure to automatically generate API documentation. Create dedicated API sections or place endpoint pages within other navigation components.

Set a default OpenAPI specification at any level of your navigation hierarchy. Child elements will inherit this specification unless they define their own specification.

Check warning on line 400 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L400

Avoid using 'will'.

```json
{
Expand Down Expand Up @@ -491,7 +491,7 @@

In the `navigation` object, `languages` is an array where each entry is an object that requires a `language` field and can contain any other navigation fields.

We currently support the following languages for localization:

Check warning on line 494 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L494

Try to avoid using first-person plural like 'We'.

<CardGroup cols={2}>
<Card title="Arabic (ar)" icon="/images/navigation/languages/ar.png" horizontal />
Expand Down Expand Up @@ -545,7 +545,7 @@

## Nesting

You can use any combination of anchors, tabs, dropdowns, and products. The components can be nested within each other interchangeably to create your desired navigation structure.

Check warning on line 548 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L548

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

<CodeGroup>

Expand Down Expand Up @@ -667,7 +667,7 @@

## Breadcrumbs

Breadcrumbs display the full navigation path at the top of pages. Some themes have breadcrumbs enabled by default and others do not. You can control whether breadcrumbs are enabled for your site using the `styling` property in your `docs.json`.

Check warning on line 670 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L670

Use 'don't' instead of 'do not'.

Check warning on line 670 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L670

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

<CodeGroup>

Expand All @@ -691,10 +691,10 @@

### Enable auto-navigation for groups

When a user expands a navigation group, some themes will automatically navigate to the first page in the group. You can override a theme's default behavior using the `drilldown` option.

Check warning on line 694 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L694

Avoid using 'will'.

- Set to `true` to force automatic navigation to the first page when a navigation group is selected.

Check warning on line 696 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L696

In general, use active voice instead of passive voice ('is selected').
- Set to `false` to prevent navigation and only expand or collapse the group when it is selected.

Check warning on line 697 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L697

Use 'it's' instead of 'it is'.

Check warning on line 697 in organize/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/navigation.mdx#L697

In general, use active voice instead of passive voice ('is selected').
- Leave unset to use the theme's default behavior.

<CodeGroup>
Expand Down
2 changes: 1 addition & 1 deletion organize/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
keywords: ["tags", "tag", "frontmatter", "metadata", "layout"]
---

Each page is an MDX file, which combines Markdown content with React components to let you create rich, interactive documentation.
Each page is a Markdown file. Both `.mdx` and `.md` file types are supported. We recommend using MDX, which combines Markdown with React components to create rich, interactive documentation. Plain Markdown (`.md`) is supported for easier migration from other platforms, but should be updated to MDX for full functionality.

Check warning on line 7 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L7

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

Check warning on line 7 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L7

Try to avoid using first-person plural like 'We'.

Check warning on line 7 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L7

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

Check warning on line 7 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L7

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

Check warning on line 7 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L7

Use 'capability' or 'feature' instead of 'functionality'.

## Page metadata

Expand All @@ -15,7 +15,7 @@
- Page titles and descriptions
- Sidebar titles, icons, and tags
- Page layouts
- SEO meta tags

Check warning on line 18 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L18

Spell out 'SEO', if it's unfamiliar to the audience.
- Custom metadata

<ResponseField name="title" type="string" required>
Expand All @@ -23,7 +23,7 @@
</ResponseField>

<ResponseField name="description" type="string">
A brief description of what this page covers. Appears under the title and improves SEO.

Check warning on line 26 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L26

Spell out 'SEO', if it's unfamiliar to the audience.
</ResponseField>

<ResponseField name="sidebarTitle" type="string">
Expand Down Expand Up @@ -70,7 +70,7 @@

### Default

If no mode is defined, defaults to a standard layout with a sidebar navigation and table of contents.

Check warning on line 73 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L73

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

```yaml
---
Expand All @@ -80,7 +80,7 @@

### Wide

Wide mode hides the table of contents. This is useful for pages that do not have any headings or if you prefer to use the extra horizontal space. Wide mode is available for all themes.

Check warning on line 83 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L83

Use 'don't' instead of 'do not'.

```yaml
---
Expand Down Expand Up @@ -147,10 +147,10 @@

## Search engine optimization

Most SEO meta tags are automatically generated. You can set SEO meta tags manually to improve your site's SEO, social sharing, and browser compatibility.

Check warning on line 150 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L150

Spell out 'SEO', if it's unfamiliar to the audience.

Check warning on line 150 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L150

Spell out 'SEO', if it's unfamiliar to the audience.

Check warning on line 150 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L150

Spell out 'SEO', if it's unfamiliar to the audience.

<Note>
Meta tags with colons must be wrapped in quotes.

Check warning on line 153 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L153

In general, use active voice instead of passive voice ('be wrapped').
</Note>

```yaml
Expand All @@ -159,11 +159,11 @@
---
```

See [SEO](/optimize/seo) for complete SEO metadata options.

Check warning on line 162 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L162

Spell out 'SEO', if it's unfamiliar to the audience.

## Internal search keywords

Enhance a specific page's discoverability in the built-in search by providing `keywords` in your metadata. These keywords won't appear as part of the page content or in search results, but users that search for them will be shown the page as a result.

Check warning on line 166 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L166

Avoid using 'will'.

Check warning on line 166 in organize/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/pages.mdx#L166

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

```yaml
---
Expand Down
2 changes: 1 addition & 1 deletion organize/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
</ResponseField>

<ResponseField name="colors" type="object" required>
The colors used in your documentation. Colors are applied differently across themes. If you only provide a primary color, it will be used for all color elements.

Check warning on line 53 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L53

Avoid using 'will'.

<Expandable title="Colors">
<ResponseField name="primary" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$" required>
Expand Down Expand Up @@ -115,7 +115,7 @@
Background image for your thumbnails. Can be a relative path or absolute URL.
</ResponseField>
<ResponseField name="fonts" type="object">
Font configuration for thumbnails. Only Google Fonts family names are supported.

Check warning on line 118 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L118

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

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
Expand Down Expand Up @@ -524,7 +524,7 @@

<Expandable title="Interaction">
<ResponseField name="drilldown" type="boolean">
Control automatic navigation behavior when selecting navigation groups. Set to `true` to force navigation to the first page when a navigation group is expanded. Set to `false` to prevent navigation and only expand or collapse the group. Leave unset to use the theme's default behavior.

Check warning on line 527 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L527

In general, use active voice instead of passive voice ('is expanded').
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -534,7 +534,7 @@

<Expandable title="Metadata">
<ResponseField name="timestamp" type="boolean">
When enabled, all pages will display the date the content was last modified. Defaults to `false`.

Check warning on line 537 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L537

Avoid using 'will'.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -612,7 +612,7 @@
Destination path to redirect to. Example: `/new-page`
</ResponseField>
<ResponseField name="permanent" type="boolean">
Whether to use a permanent redirect (301). Defaults to `true`.

Check warning on line 615 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L615

Use parentheses judiciously.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -646,7 +646,7 @@
</Expandable>
</ResponseField>

### API Configurations

Check warning on line 649 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L649

'API Configurations' should use sentence-style capitalization.

<ResponseField name="api" type="object">
API documentation and interactive playground settings.
Expand Down Expand Up @@ -721,7 +721,7 @@
</Expandable>
</ResponseField>
<ResponseField name="mdx" type="object">
Configurations for API pages generated from `MDX` files.
Configurations for API pages generated from MDX files.

<Expandable title="Mdx">
<ResponseField name="auth" type="object">
Expand All @@ -744,10 +744,10 @@
</Expandable>
</ResponseField>

### SEO and search

Check warning on line 747 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L747

Spell out 'SEO', if it's unfamiliar to the audience.

Check warning on line 747 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L747

'SEO and search' should use sentence-style capitalization.

<ResponseField name="seo" type="object">
SEO indexing configurations.

Check warning on line 750 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L750

Spell out 'SEO', if it's unfamiliar to the audience.

<Expandable title="Seo">
<ResponseField name="metatags" type="object">
Expand Down