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
6 changes: 2 additions & 4 deletions advanced/dashboard/sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@
---

<Info>
SSO functionality is available on our [Enterprise
plan](https://mintlify.com/pricing?ref=sso). Please{" "}
<a href="mailto:[email protected]">contact sales</a> for more information.
SSO functionality is available on [Enterprise plan](https://mintlify.com/pricing?ref=sso).
</Info>

Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google Workspace, or Microsoft Entra, we have provider-specific documentation for setting up SSO. If you use another provider, please [contact us](mailto:sales@mintlify.com).
Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google Workspace, or Microsoft Entra, we have provider-specific documentation for setting up SSO. If you use another provider, please [contact us](mailto:support@mintlify.com).

Check warning on line 10 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L10

Did you really mean 'Okta'?

Check warning on line 10 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L10

Did you really mean 'Entra'?

## Okta

Check warning on line 12 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L12

Did you really mean 'Okta'?

<Tabs>
<Tab title="SAML">
Expand Down Expand Up @@ -47,7 +45,7 @@
</Step>
<Step title="Send us your IdP information">
Once the application is set up, navigate to the General tab and locate the client ID & client secret.
Please securely provide us with these, along with your Okta instance URL (e.g. `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.

Check warning on line 48 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L48

Did you really mean 'Okta'?
</Step>
</Steps>
</Tab>
Expand Down Expand Up @@ -93,7 +91,7 @@
</Tab>
</Tabs>

## Microsoft Entra

Check warning on line 94 in advanced/dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/sso.mdx#L94

Did you really mean 'Entra'?

<Tabs>
<Tab title="SAML">
Expand Down
3 changes: 1 addition & 2 deletions authentication-personalization/authentication-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,7 @@
**Need help choosing?** See the [overview](/authentication-personalization/overview) to compare options.

<Info>
Authentication methods are available on the [Growth and Enterprise plans](https://mintlify.com/pricing?ref=authentication). Please{" "}
<a href="mailto:[email protected]">contact sales</a> for more information.
Authentication methods are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=authentication).
</Info>

## Configuring authentication
Expand All @@ -20,7 +19,7 @@
<Tab title="JWT">
### Prerequisites

* An authentication system that can generate and sign JWTs.

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L22

Did you really mean 'JWTs'?
* A backend service that can create redirect URLs.

### Implementation
Expand Down Expand Up @@ -55,20 +54,20 @@

<CodeGroup>
```ts TypeScript
import * as jose from 'jose';

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L57

Did you really mean 'jose'?
import { Request, Response } from 'express';

const TWO_WEEKS_IN_MS = 1000 * 60 * 60 * 24 * 7 * 2;

const signingKey = await jose.importPKCS8(process.env.MINTLIFY_PRIVATE_KEY, 'EdDSA');

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L62

Did you really mean 'signingKey'?

export async function handleRequest(req: Request, res: Response) {
const user = {
expiresAt: Math.floor((Date.now() + TWO_WEEKS_IN_MS) / 1000), // 2 week session expiration

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L66

Did you really mean 'expiresAt'?
groups: res.locals.user.groups,
content: {
firstName: res.locals.user.firstName,

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L69

Did you really mean 'firstName'?
lastName: res.locals.user.lastName,

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L70

Did you really mean 'lastName'?
},
};

Expand Down Expand Up @@ -169,8 +168,8 @@
```json
{
"content": {
"firstName": "Jane",

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L171

Did you really mean 'firstName'?
"lastName": "Doe"

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

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/authentication-setup.mdx#L172

Did you really mean 'lastName'?
},
"groups": ["engineering", "admin"]
}
Expand Down
3 changes: 1 addition & 2 deletions authentication-personalization/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
icon: "badge-info"
---
<Info>
Authentication methods are available on the [Growth and Enterprise plans](https://mintlify.com/pricing?ref=authentication). Please{" "}
<a href="mailto:[email protected]">contact sales</a> for more information.
Authentication methods are available on the [Growth and Enterprise plans](https://mintlify.com/pricing?ref=authentication).
</Info>

There are three approaches to manage access and customize your documentation based on user information.
Expand Down Expand Up @@ -115,13 +114,13 @@
fields. For example, `{user.org?.plan}`.
</Note>

### API key prefilling

Check warning on line 117 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/overview.mdx#L117

Did you really mean 'prefilling'?

Automatically populate API playground fields with user-specific values by returning matching field names in your user data. The field names in your user data must exactly match the names in the API playground for automatic prefilling to work.

Check warning on line 119 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/overview.mdx#L119

Did you really mean 'prefilling'?

### Page visibility

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.

Check warning on line 123 in authentication-personalization/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

authentication-personalization/overview.mdx#L123

Did you really mean 'frontmatter'?

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

Expand Down
2 changes: 1 addition & 1 deletion changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
- Improved styling nits for dashboard border for mobile-tablet-desktop responsiveness
- Show code examples even when in simple mode for API playground
- Support "command \+ k" shortcut for search in web editor
- Codeblocks within callouts expand to fill the width of the callout area

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L86

Did you really mean 'Codeblocks'?

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L86

Did you really mean 'callouts'?

Check warning on line 86 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L86

Did you really mean 'callout'?
</Update>

<Update label="February 2025">
Expand Down Expand Up @@ -114,9 +114,9 @@

Automatically lint your docs to find broken links, discover spelling and grammar issues, or enforce writing styles with your own Vale config. Learn more in our [docs](settings/ci).

## .md support for LLMs

Check warning on line 117 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L117

Did you really mean 'LLMs'?

All documentation pages are now automatically available as plain Markdown files—just append `.md` to the URL. This makes it easier for LLMs to ingest individual pages from your documentation.

Check warning on line 119 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L119

Did you really mean 'LLMs'?

## More Themes

Expand Down Expand Up @@ -198,7 +198,7 @@
<Frame>
![llms.txt support](/images/changelog/llms.jpg)
</Frame>
All docs instances are now automatically hosted at /llms.txt and /llms-full.txt so that LLMs can easily ingest your documentation. For more information, read the [docs on the new llms.txt standard.](https://llmstxt.org)

Check warning on line 201 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L201

Did you really mean 'LLMs'?

## Localization

Expand Down Expand Up @@ -265,12 +265,12 @@

## Custom Prompts for AI Chat

You can now customize the prompts for the AI chat. Please reach out to [support](mailto:sales@mintlify.com) if you'd like to customize the prompts.
You can now customize the prompts for the AI chat. Please reach out to [support](mailto:support@mintlify.com) if you'd like to customize the prompts.

## Dashboard Improvements

- Added ability to change custom domain to be /docs directly through dashboard settings.
- Consolidated the login and signup pages to decrease friction and confusion.

Check warning on line 273 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L273

Did you really mean 'signup'?
- Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them.
- Added login with Google OAuth
- Added ability to add new deployment through dashboard settings.
Expand All @@ -284,7 +284,7 @@
- Don't allow search engines to crawl user-auth protected pages.
- Revalidate the cache when an org is deleted.
- We now use the Scalar OpenAPI parser to parse OpenAPI definitions which improves the performance, fixes parsing issues, and surfaces better error messages.
- Top-level descriptions are now supported in API reference pages autogenerated from OpenAPI definitions.

Check warning on line 287 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L287

Did you really mean 'autogenerated'?
- Add in-line-style support for icons
- Fixed the pop-in of custom CSS in docs.
- Properly show in-line code styling in conjunction with links.
Expand Down Expand Up @@ -317,7 +317,7 @@
<Frame>
![SEO Improvements](/images/changelog/seo-improvements.jpeg)
</Frame>
We've fixed both the mobile and desktop layout of our docs so that they are more SEO-friendly - including adding proper aria tags to navbar and toggle elements.

Check warning on line 320 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L320

Did you really mean 'navbar'?

## Dashboard Improvements

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

## File Uploads in API Playground

By default, API playground requests are proxied by Mintlify. Now you can use

Check warning on line 354 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L354

Did you really mean 'proxied'?
`disableProxy` to disable this behavior and support request types like file
uploads.

Expand Down Expand Up @@ -384,7 +384,7 @@
</Frame>
For `Pro` users, we introduced Mintlify Widget, an extension of your docs to
answer your users' questions when and where they asked. You can add this
AI-powered chatbot to any web page: your landing page, inside your product, or

Check warning on line 387 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L387

Did you really mean 'chatbot'?
on your existing documentation pages.

- [Read the blog announcement](https://mintlify.com/blog/widget)
Expand Down Expand Up @@ -419,7 +419,7 @@
<Update label="May 2024">
## Okta SSO

We now support sign-on via Okta SAML and OIDC.

Check warning on line 422 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L422

Did you really mean 'Okta'?

## Mintlify REST API

Expand All @@ -442,7 +442,7 @@
<Update label="March 2024">
## Mintlify MDX for VSCode

Call snippets of our pre-built components and callouts without leaving VSCode. [Install the extension here](https://marketplace.visualstudio.com/items?itemName=mintlify.mintlify-snippets).

Check warning on line 445 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L445

Did you really mean 'callouts'?
</Update>

<Update label="February 2024">
Expand All @@ -451,7 +451,7 @@
- Dashboard upgrades: view update logs to see what's changed and status of an update, toggle between Mintlify projects to manage deployments
- Versioning with tabs fully supported
- Wildcard redirects now supported
- CLI Error Detection: we now show the position of invalid frontmatter when there are parsing issues during local development

Check warning on line 454 in changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

changelog.mdx#L454

Did you really mean 'frontmatter'?
</Update>

<Update label="January 2024">
Expand Down
9 changes: 4 additions & 5 deletions settings/ci.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
title: CI Checks
description: "Add broken links, linting, and grammar checks to the updating process"
icon: 'circle-check'
title: "CI Checks"
description: "Add checks for broken links, linting, and grammar to the updating process"
icon: "circle-check"
---

<Info>
This feature is only available for customers on [paid plans](https://mintlify.com/pricing?ref=docs-ci) and for GitHub. Support for other platforms is coming soon. Please{" "}
<a href="mailto:[email protected]">contact sales</a> for more information.
CI checks are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=docs-ci), an add-on for other plans, and for GitHub.
</Info>

Use CI checks to lint your docs for errors, and give you warnings before you deploy.
Expand Down
6 changes: 3 additions & 3 deletions settings/custom-domain.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Custom Domain'
title: "Custom Domain"
description: "Host your documentation at your website's custom domain"
icon: 'globe'
icon: "globe"
---

To set up your documentation on a custom domain, you'll need to set your desired custom domain in your Mintlify settings and configure your DNS settings on your domain provider.
Expand Down Expand Up @@ -31,9 +31,9 @@
/>
</Frame>

## Verification with Vercel

Check warning on line 34 in settings/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-domain.mdx#L34

Did you really mean 'Vercel'?

If Vercel happens to be your domain provider, you will have to add a verification `TXT` record. This information will show on your dashboard after submitting your custom domain, as well as be emailed to you.

Check warning on line 36 in settings/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings/custom-domain.mdx#L36

Did you really mean 'Vercel'?

## Configuring your DNS

Expand All @@ -50,4 +50,4 @@

If you are using Cloudflare for your DNS provider, you'll need to have the “full strict” security option enabled for the https setting.

Please [contact support](mailto:sales@mintlify.com) if you don't see the custom domain set up after the above configuration.
Please [contact support](mailto:support@mintlify.com) if you don't see the custom domain set up after the above configuration.
5 changes: 2 additions & 3 deletions settings/preview-deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ icon: "scan-eye"
---

<Info>
Preview deployments are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments). Please{" "}
<a href="mailto:[email protected]">contact sales</a> for more information.
Preview deployments are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments).
</Info>

Preview deployments let you see how changes to your docs will look before merging to production. Each preview creates a shareable URL that updates automatically as you push new changes.
Expand Down Expand Up @@ -52,4 +51,4 @@ Preview deployments can be publicly accessible or restricted to authenticated us

**Public access**: Preview URLs are publicly viewable by default. Share a preview link with anyone who needs to review your changes.

**Restricted access**: Enable preview deployment authentication to limit preview access to authenticated Mintlify users only. [Contact sales](mailto:[email protected]) to set up authentication for your previews.
**Restricted access**: Enable preview deployment authentication to limit preview access to authenticated Mintlify users only. See [Authentication Setup](/authentication-personalization/authentication-setup) for more information.
3 changes: 1 addition & 2 deletions translations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
---

<Info>
Automated translations are available as a paid add-on to Growth, Pro, and Enterprise plans. Please{" "}
<a href="mailto:[email protected]">contact sales</a> for more information.
Automated translations are available as a paid add-on to [Growth, Pro, and Enterprise plans](https://mintlify.com/pricing).
</Info>

## Overview
Expand Down Expand Up @@ -93,7 +92,7 @@
* **Ambiguous link anchors**: Accurately describe where a link goes and avoid ambiguous link anchors like `Click here`. When possible, use the exact title of the page or resource that a link points to.
* **Avoid**: "Click `[here](path/to/getting-started-guide)` to learn more about the setup process."
* **Better**: "Learn more about the setup process in our `[getting started guide](path/to/getting-started-guide)`."
* **Nominalizations**: Verbs or adjectives turned into nouns, often ending in -ion, -ment, or -ness. Use active verbs instead.

Check warning on line 95 in translations.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

translations.mdx#L95

Did you really mean 'Nominalizations'?
* **Avoid**: "The configuration of your navigation requires a valid `docs.json`."
* **Better**: "You must have a valid `docs.json` to configure your navigation."
* **Stacked modifiers**: Multiple nouns or adjectives grouped together create ambiguity about relationships between words.
Expand Down