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
4 changes: 4 additions & 0 deletions authentication-personalization/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@

Choose between full and partial authentication modes based on your access control needs.

**Full authentication**: All pages are protected. Users must log in before accessing any content.

Check warning on line 20 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L20

': A' should be in lowercase.

Check warning on line 20 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L20

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

**Partial authentication**: Some pages are publicly viewable while others require authentication. Users can browse public content freely and authenticate only when accessing protected pages.

Check warning on line 22 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L22

': S' should be in lowercase.

<Info>
Partial authentication supports redirects for unauthenticated users. When an unauthenticated user visits a redirect source path, the system will check the destination page's authentication requirements and return the appropriate access metadata.

Check warning on line 25 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L25

Avoid using 'will'.
</Info>

When configuring any handshake method below, you'll select either **Full authentication** or **Partial authentication** in your dashboard settings.

## Configuring authentication
Expand All @@ -30,7 +34,7 @@
<Tabs>
<Tab title="Password">
<Info>
Password authentication provides access control only and does **not** support content personalization.

Check warning on line 37 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L37

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

### Prerequisites
Expand All @@ -54,9 +58,9 @@

## Example

Your documentation is hosted at `docs.foo.com` and you need basic access control without tracking individual users. You want to prevent public access while keeping setup simple.

Check warning on line 61 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L61

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

**Create a strong password** in your dashboard. **Share credentials** with authorized users. That's it!

Check warning on line 63 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L63

Don't use exclamation points in text.
</Tab>
<Tab title="Mintlify Dashboard">
### Prerequisites
Expand All @@ -81,17 +85,17 @@

### Example

Your documentation is hosted at `docs.foo.com` and your team uses the dashboard to edit your docs. You want to restrict access to team members only.

Check warning on line 88 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L88

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

**Enable Mintlify authentication** in your dashboard settings.

**Verify team access** by checking that all team members are added to your organization.

Check warning on line 92 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L92

In general, use active voice instead of passive voice ('are added').
</Tab>
<Tab title="OAuth 2.0">
### Prerequisites

* An OAuth or OIDC server that supports the Authorization Code Flow.

Check warning on line 97 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L97

Spell out 'OIDC', if it's unfamiliar to the audience.
* Ability to create an API endpoint accessible by OAuth access tokens (optional, to enable personalization features).

Check warning on line 98 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L98

Use parentheses judiciously.

### Implementation

Expand All @@ -100,13 +104,13 @@
1. In your dashboard, go to [Authentication](https://dashboard.mintlify.com/settings/deployment/authentication).
2. Select **Full Authentication** or **Partial Authentication**.
3. Select **OAuth** and configure these fields:
* **Authorization URL**: Your OAuth endpoint.

Check warning on line 107 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L107

': Y' should be in lowercase.
* **Client ID**: Your OAuth 2.0 client identifier.
* **Client Secret**: Your OAuth 2.0 client secret.
* **Scopes**: Permissions to request. Copy the **entire** scope string (for example, for a scope like `provider.users.docs`, copy the complete `provider.users.docs`). Use multiple scopes if you need different access levels.

Check warning on line 110 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L110

Use parentheses judiciously.

Check warning on line 110 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L110

': P' should be in lowercase.
* **Token URL**: Your OAuth token exchange endpoint.
* **Info API URL** (optional): Endpoint to retrieve user info for personalization. If omitted, the OAuth flow will only be used to verify identity and the user info will be empty.

Check warning on line 112 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L112

Use parentheses judiciously.

Check warning on line 112 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L112

': E' should be in lowercase.

Check warning on line 112 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L112

Avoid using 'will'.

Check warning on line 112 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L112

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

Check warning on line 112 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L112

Avoid using 'will'.
* **Logout URL**: The native logout URL for your OAuth provider. If your provider has a `returnTo` or similar parameter, point it back to your docs URL.

Check warning on line 113 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L113

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

### Example

Your documentation is hosted at `foo.com/docs` and you have an existing OAuth server at `auth.foo.com` that supports the Authorization Code Flow.

Check warning on line 131 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L131

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

**Configure your OAuth server details** in your dashboard:
- **Authorization URL**: `https://auth.foo.com/authorization`
Expand All @@ -142,7 +146,7 @@
"firstName": "Jane",
"lastName": "Doe"
},
"groups": ["engineering", "admin"]

Check warning on line 149 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L149

Commas and periods go inside quotation marks.

Check warning on line 149 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L149

Use 'administrator' instead of 'admin'.
}
```

Expand Down Expand Up @@ -243,7 +247,7 @@

### Redirecting unauthenticated users

When an unauthenticated user tries to access a protected page, their intended destination is preserved in the redirect to your login URL:

Check warning on line 250 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L250

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

1. User attempts to visit a protected page: `https://docs.foo.com/quickstart`.
2. Redirect to your login URL with a redirect query parameter: `https://foo.com/docs-login?redirect=%2Fquickstart`.
Expand All @@ -254,7 +258,7 @@

## Making pages public

When using partial authentication, all pages are protected by default. You can make specific pages viewable without authentication at the page or group level with the `public` property.

Check warning on line 261 in authentication-personalization/authentication-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L261

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

### Page level

Expand Down
4 changes: 4 additions & 0 deletions settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@
Font weight, such as 400, 700. Variable fonts support precise weights such as 550.
</ResponseField>
<ResponseField name="source" type="string (uri)">
URL to your font source, such as https://mintlify-assets.b-cdn.net/fonts/Hubot-Sans.woff2. [Google Fonts](https://fonts.google.com) are loaded automatically when you specify a Google Font `family` name, so no source URL is needed.

Check warning on line 222 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L222

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

Check warning on line 222 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L222

In general, use active voice instead of passive voice ('is needed').
</ResponseField>
<ResponseField name="format" type="&quot;woff&quot; | &quot;woff2&quot;">
Font file format.
Expand Down Expand Up @@ -495,7 +495,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 498 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L498

In general, use active voice instead of passive voice ('is expanded').
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -572,9 +572,13 @@
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 575 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L575

Use parentheses judiciously.
</ResponseField>
</Expandable>

<Note>
**Partial authentication support**: When using [partial authentication](/authentication-personalization/authentication-setup#authentication-modes), redirects work for unauthenticated users. If an unauthenticated user visits a redirect source path, the system checks the destination page's authentication requirements and returns the appropriate access metadata. Wildcard redirects are not supported with partial authentication.

Check warning on line 580 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L580

': W' should be in lowercase.

Check warning on line 580 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L580

Use 'aren't' instead of 'are not'.
</Note>
</ResponseField>

<ResponseField name="contextual" type="object">
Expand All @@ -583,13 +587,13 @@
<Expandable title="Contextual">
<ResponseField name="options" type="array of &quot;copy&quot; | &quot;view&quot; | &quot;chatgpt&quot; | &quot;claude&quot; | &quot;perplexity&quot; | &quot;mcp&quot; | &quot;cursor&quot; | &quot;vscode&quot;" required>
Actions available in the contextual menu. The first option appears as the default.
- `copy`: Copy the current page as Markdown to the clipboard.

Check warning on line 590 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L590

': C' should be in lowercase.
- `view`: View the current page as Markdown in a new tab.

Check warning on line 591 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L591

': V' should be in lowercase.
- `chatgpt`: Send the current page content to ChatGPT.

Check warning on line 592 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L592

': S' should be in lowercase.
- `claude`: Send the current page content to Claude.
- `perplexity`: Send the current page content to Perplexity.
- `mcp`: Copies your MCP server URL to the clipboard.
- `cursor`: Installs your hosted MCP server in Cursor.

Check warning on line 596 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L596

': I' should be in lowercase.
- `vscode`: Installs your hosted MCP server in VSCode.

<img src="/images/page-context-menu.png" alt="Contextual Menu" className="rounded-xl" />
Expand All @@ -602,7 +606,7 @@
</Expandable>
</ResponseField>

### API Configurations

Check warning on line 609 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L609

'API Configurations' should use sentence-style capitalization.

<ResponseField name="api" type="object">
API documentation and interactive playground settings.
Expand Down Expand Up @@ -698,10 +702,10 @@
</Expandable>
</ResponseField>

### SEO and search

Check warning on line 705 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L705

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

Check warning on line 705 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L705

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

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

Check warning on line 708 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L708

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

<Expandable title="Seo">
<ResponseField name="metatags" type="object">
Expand Down Expand Up @@ -937,7 +941,7 @@
404 "Page not found" error handling.
<Expandable title="404">
<ResponseField name="redirect" type="boolean">
Whether to automatically redirect to the home page when a page is not

Check warning on line 944 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L944

Use 'isn't' instead of 'is not'.
found.
</ResponseField>
<ResponseField name="title" type="string">
Expand Down Expand Up @@ -1493,7 +1497,7 @@

</CodeGroup>

If you already have the CLI installed, make sure it is up to date:

Check warning on line 1500 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1500

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

Check warning on line 1500 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1500

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

```bash
mint update
Expand All @@ -1507,7 +1511,7 @@
mint upgrade
```

This command will create a `docs.json` file from your existing `mint.json`. Review the generated file to ensure all settings are correct.

Check warning on line 1514 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings.mdx#L1514

Avoid using 'will'.
</Step>
<Step title="Delete your mint.json file">
After verifying your `docs.json` is configured properly, you can safely delete your old `mint.json` file.
Expand Down
Loading