diff --git a/.vale.ini b/.vale.ini index 9c3a813f9..febeefd3b 100644 --- a/.vale.ini +++ b/.vale.ini @@ -22,7 +22,8 @@ Vale.Avoid = NO # Too aggressive about common technical terms # Token and block ignores for MDX-specific syntax TokenIgnores = (?sm)((?:import|export) .+?$), \ (?)(?!`), \ -(<[A-Z]\w+>.+?<\/[A-Z]\w+>) +(<[A-Z]\w+>.+?<\/[A-Z]\w+>), \ +(<[^>]*>) BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \ (?sm)^({.+.*}) diff --git a/.vale/styles/Google/Quotes.yml b/.vale/styles/Google/Quotes.yml index 3cb6f1abd..d8eb51fd3 100644 --- a/.vale/styles/Google/Quotes.yml +++ b/.vale/styles/Google/Quotes.yml @@ -4,4 +4,5 @@ link: 'https://developers.google.com/style/quotation-marks' level: error nonword: true tokens: - - '"[^"]+"[.,?]' + # Match quotes with trailing punctuation, but exclude content in JSON + - '(? 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. `.okta.com`). You can send these via a service like 1Password or SendSafely. + Please securely provide us with these, along with your Okta instance URL (for example, `.okta.com`). You can send these via a service like 1Password or SendSafely. @@ -97,7 +97,7 @@ Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google - 1. Under "Enterprise applications", select **New application**. + 1. Under "Enterprise applications," select **New application**. 2. Select **Create your own application** and choose "Integrate any other application you don't find in the gallery (Non-gallery)." diff --git a/advanced/subpath/route53-cloudfront.mdx b/advanced/subpath/route53-cloudfront.mdx index a39be3c41..bcd6589e0 100644 --- a/advanced/subpath/route53-cloudfront.mdx +++ b/advanced/subpath/route53-cloudfront.mdx @@ -70,7 +70,7 @@ All Behaviors must have the an **origin request policy** of `AllViewerExceptHost If you use Vercel, use the `.vercel.app` domain available for every project. -3. Create a new Origin and add your staging URL as the "Origin domain". +3. Create a new Origin and add your staging URL as the "Origin domain." ![CloudFront "Create origin" page with a "Origin domain" input field highlighted.](/images/cloudfront/default-origin.png) @@ -101,7 +101,7 @@ Behaviors in CloudFront enable control over the subpath logic. At a high level, Create behaviors for Vercel domain verification paths with a **Path pattern** of `/.well-known/*` and set **Origin and origin groups** to your docs URL. -For "Cache policy", select **CachingDisabled** to ensure these verification requests pass through without caching. +For "Cache policy," select **CachingDisabled** to ensure these verification requests pass through without caching. ![CloudFront "Create behavior" page with a "Path pattern" of "/.well-known/*" and "Origin and origin groups" pointing to the staging URL.](/images/cloudfront/well-known-policy.png) diff --git a/changelog.mdx b/changelog.mdx index 8a0e11113..45b452f2a 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -184,7 +184,7 @@ noindex: true ## API playground enhancements - New [Search API endpoint](https://mintlify.com/docs/api-reference/assistant/search) so you can build agents and MCP servers on top of your docs - - `openapi` and `asyncapi` files are now served at their specified paths (e.g. `https://mydocsurl.extension/{openapi-or-file-name}.json`) + - `openapi` and `asyncapi` files are now served at their specified paths (for example, `https://mydocsurl.extension/{openapi-or-file-name}.json`) - You can now use the [`x-mint` field in your openapi files](https://mintlify.com/docs/api-playground/openapi-setup#x-mint-extension) to override generated fields, customize preface content, or change endpoint URLs in code samples - [`x-mcp` is now `x-mint.mcp`](https://mintlify.com/docs/api-playground/openapi-setup#mcp) in OpenAPI configurations to control which routes are exposed as MCP tools @@ -426,7 +426,7 @@ noindex: true ## AI Assistant Improvements - New UI with dedicated chat page & pre-filled prompts - - Stability improvements, e.g. bug fixes of editing the wrong file or no files at all + - Stability improvements. For example, bug fixes of editing the wrong file or no files at all - More robust knowledge for adding & editing components - Improved `docs.json` file editing @@ -439,7 +439,7 @@ noindex: true We’ve overhauled the design and performance of the [API Playground](/api-playground/). Updates include: - Easier detail expansion for an overview of a field - - More intuitive nested design, e.g. adding or deleting items + - More intuitive nested design. For example, adding or deleting items - Faster response times ## Quality Improvements diff --git a/components/cards.mdx b/components/cards.mdx index 87323c823..db1151f79 100644 --- a/components/cards.mdx +++ b/components/cards.mdx @@ -107,7 +107,7 @@ Use the [Columns component](/components/columns) to organize multiple cards side - Icon color as a hex code (e.g., `#FF6B6B`). + Icon color as a hex code (for example, `#FF6B6B`). diff --git a/guides/auth0.mdx b/guides/auth0.mdx index 2d3b6843e..f976c7e13 100644 --- a/guides/auth0.mdx +++ b/guides/auth0.mdx @@ -13,7 +13,7 @@ This guide walks you through setting up Auth0 as an authentication provider for - Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Click the **Create Application** button, give your application a name (e.g., "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**. + Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Click the **Create Application** button, give your application a name (for example, "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**. ![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png) @@ -23,7 +23,7 @@ This guide walks you through setting up Auth0 as an authentication provider for ![Auth0 client settings page](/images/guides/auth0/auth0clientsettings.png) Make note of the following information: - - **Domain**: This is your Auth0 tenant domain (e.g., `your-tenant.auth0.com`) + - **Domain**: This is your Auth0 tenant domain (for example, `your-tenant.auth0.com`) - **Client ID**: The public identifier for your application - **Client Secret**: The secret key for your application (keep this secure) diff --git a/image-embeds.mdx b/image-embeds.mdx index 700030a79..3725e0d14 100644 --- a/image-embeds.mdx +++ b/image-embeds.mdx @@ -32,7 +32,7 @@ Use [Markdown syntax](https://www.markdownguide.org/basic-syntax/#images) to add Always include descriptive alt text to improve accessibility and SEO. The alt text should clearly describe what the image shows. -Image files must be less than 20MB. For larger files, host them on a CDN service like [Amazon S3](https://aws.amazon.com/s3) or [Cloudinary](https://cloudinary.com). +Image files must be less than 20 MB. For larger files, host them on a CDN service like [Amazon S3](https://aws.amazon.com/s3) or [Cloudinary](https://cloudinary.com). ### HTML image embeds diff --git a/installation.mdx b/installation.mdx index 988d4e196..69a05574f 100644 --- a/installation.mdx +++ b/installation.mdx @@ -116,7 +116,7 @@ You can use the CLI to check your OpenAPI file for errors using the following co mint openapi-check ``` -You can pass in a filename (e.g. `./openapi.yaml`) or a URL (e.g. `https://petstore3.swagger.io/api/v3/openapi.json`). +You can pass in a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`). ### Renaming files