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
6 changes: 3 additions & 3 deletions ai-ingestion.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "AI ingestion"
description: "Prepare your documentation for LLMs and AI tools"

Check warning on line 3 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L3

Did you really mean 'LLMs'?
icon: "bot-message-square"
---

Expand All @@ -12,7 +12,7 @@
)
}

Mintlify generates optimized formats and provides shortcuts that help users get faster, more accurate responses when using your documentation as context for LLMs and AI tools.

Check warning on line 15 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L15

Did you really mean 'LLMs'?

## Contextual menu

Expand Down Expand Up @@ -40,8 +40,8 @@
"options": [
"copy",
"view",
"chatgpt",

Check warning on line 43 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L43

Did you really mean 'chatgpt'?
"claude"

Check warning on line 44 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L44

Did you really mean 'claude'?
]
}
}
Expand All @@ -49,19 +49,19 @@

## /llms.txt

The [/llms.txt file](https://llmstxt.org) is an industry standard that helps general-purpose LLMs index more efficiently, similar to how a sitemap helps search engines.

Check warning on line 52 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L52

Did you really mean 'LLMs'?

Every documentation site automatically hosts an `/llms.txt` file at the root that lists all available pages in your documentation. AI tools can use this file to understand your documentation structure and find relevant content to user prompts.

<PreviewButton href="https://mintlify.com/docs/llms.txt">Open llms.txt for this site</PreviewButton>
<PreviewButton href="/llms.txt">Open llms.txt for this site</PreviewButton>

## /llms-full.txt

The `/llms-full.txt` file combines your entire documentation site into a single file as context for AI tools.

Every documentation site automatically hosts an `/llms-full.txt` file at the root.

<PreviewButton href="https://mintlify.com/docs/llms-full.txt">Open llms-full.txt for this site</PreviewButton>
<PreviewButton href="/llms-full.txt">Open llms-full.txt for this site</PreviewButton>

## Generating Markdown versions of pages

Expand All @@ -71,8 +71,8 @@

Add a `.md` to a page's URL to display a Markdown version of that page.

<PreviewButton href="https://mintlify.com/docs/quickstart.md">Open quickstart.md</PreviewButton>
<PreviewButton href="/quickstart.md">Open quickstart.md</PreviewButton>

### Command \+ C shortcut

Select Command \+ C (Ctrl \+ C on Windows) to copy any page as Markdown.

Check warning on line 78 in ai-ingestion.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

ai-ingestion.mdx#L78

Did you really mean 'Ctrl'?
Empty file.
Empty file added api-playground/introduction.mdx
Empty file.
Empty file added api-playground/settings.mdx
Empty file.
2 changes: 1 addition & 1 deletion api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ If your API pages aren't displaying correctly, check these common configuration
requests, then all of these requests will fail. To fix this, configure your reverse proxy to
allow `POST` requests to the `/api/request` path.

Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described [here](settings#api-configurations). This will
Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described [here](/settings#param-proxy). This will
likely require you to configure CORS on your server, as these requests will now come directly
from your users' browsers.
</Accordion>
Expand Down
Empty file added api-playground/usage.mdx
Empty file.
Empty file added components/accordion.mdx
Empty file.
Empty file added components/api.mdx
Empty file.
Empty file added components/card-group.mdx
Empty file.
Empty file added components/card.mdx
Empty file.
2 changes: 1 addition & 1 deletion components/cards.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

Add an `img` property to display an image on the top of the card.

<Card title="Image Card" img="https://mintlify-assets.b-cdn.net/yosemite.jpg">
<Card title="Image Card" img="/images/yosemite.jpg">
Here is an example of a card with an image
</Card>

Expand Down Expand Up @@ -91,7 +91,7 @@
</ResponseField>

<ResponseField name="icon" type="string or svg">
A [Font Awesome icon](https://fontawesome.com/icons), [Lucide

Check warning on line 94 in components/cards.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

components/cards.mdx#L94

Did you really mean 'Lucide'?
icon](https://lucide.dev/icons), or JSX compatible SVG code in `icon={}`.

To generate JSX compatible SVG code:
Expand Down
Empty file added components/code-group.mdx
Empty file.
Empty file added components/code.mdx
Empty file.
Empty file added components/frame.mdx
Empty file.
Empty file added components/parameter.mdx
Empty file.
Empty file added components/response-field.mdx
Empty file.
Empty file added components/tab-group.mdx
Empty file.
Empty file added components/table.mdx
Empty file.
Empty file added components/tooltip.mdx
Empty file.
Empty file added development.mdx
Empty file.
Empty file added essentials/code.mdx
Empty file.
Empty file added essentials/content.mdx
Empty file.
Empty file added essentials/images.mdx
Empty file.
Empty file added essentials/markdown.mdx
Empty file.
Empty file added essentials/navigation.mdx
Empty file.
Empty file added faqs.mdx
Empty file.
Empty file added getting-started.mdx
Empty file.
2 changes: 1 addition & 1 deletion guides/assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
---

<Info>
The AI assistant is automatically enabled on [Pro, Growth, and Enterprise plans](https://mintlify.com/pricing?ref=assistant).
The AI assistant is automatically enabled on [Pro, Growth, and Enterprise plans](/pricing?ref=assistant).
</Info>

## About the assistant

The assistant answers questions about your documentation through natural language queries. It is embedded directly in your documentation site, providing users with immediate access to contextual help.

The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Sonnet 4. When users ask questions, the assistant:

Check warning on line 15 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L15

Did you really mean 'agentic'?

* **Searches and retrieves** relevant content from your documentation to provide accurate answers.
* **Cites sources** and provides navigable links to take users directly to referenced pages.
Expand All @@ -28,7 +28,7 @@

Users can access the assistant in two ways:

- **Keyboard shortcut**: <kbd>Command</kbd> + <kbd>I</kbd> (<kbd>Ctrl</kbd> + <kbd>I</kbd> on Windows)

Check warning on line 31 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L31

Did you really mean 'Ctrl'?
- **Assistant button** next to the search bar
<img
src="/images/assistant/assistant-button-light.png"
Expand All @@ -51,7 +51,7 @@

Both methods open a chat panel on the right side of your docs. Users can ask any question and the assistant will search your documentation for an answer. If no relevant information is found, the assistant will respond that it cannot answer the question.

## Making content AI ingestible

Check warning on line 54 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L54

Did you really mean 'ingestible'?

Structure your documentation to help the assistant provide accurate, relevant answers. Clear organization and comprehensive context benefit both human readers and AI understanding.

Expand All @@ -60,7 +60,7 @@
- Write descriptive headings for sections.
- Create a logical information hierarchy.
- Use consistent formatting across your docs.
- Include comprehensive metadata in page frontmatter.

Check warning on line 63 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

guides/assistant.mdx#L63

Did you really mean 'frontmatter'?
- Break up long blocks of text into shorter paragraphs.
</Card>

Expand Down
Empty file added guides/custom-domain.mdx
Empty file.
Empty file added guides/forms.mdx
Empty file.
Empty file added guides/i18n.mdx
Empty file.
Empty file added guides/metadata.mdx
Empty file.
Empty file added guides/node-api.mdx
Empty file.
Empty file added guides/sdk-openapi.mdx
Empty file.
Empty file added guides/search.mdx
Empty file.
Empty file added guides/snippets.mdx
Empty file.
Empty file added guides/sso.mdx
Empty file.
Empty file added guides/swagger.mdx
Empty file.
Empty file added guides/teams.mdx
Empty file.
Empty file added guides/versioning.mdx
Empty file.
Empty file added guides/webhook-proxy.mdx
Empty file.
Empty file added hosting.mdx
Empty file.
Empty file added integrations/algolia.mdx
Empty file.
Empty file added integrations/checkly.mdx
Empty file.
Empty file added integrations/dark-mode.mdx
Empty file.
Empty file added integrations/fathom.mdx
Empty file.
Empty file.
2 changes: 1 addition & 1 deletion integrations/sdks/speakeasy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
description: Automate your SDK usage snippets in the API playground
---

You can integrate Speakeasy-generated code snippets from your SDKs directly into your Mintlify API reference documentation. SDK usage snippets are shown in the [interactive playground](https://mintlify.com/docs/api-playground/overview) of your Mintlify-powered documentation.
You can integrate Speakeasy-generated code snippets from your SDKs directly into your Mintlify API reference documentation. SDK usage snippets are shown in the [interactive playground](/api-playground/overview) of your Mintlify-powered documentation.

Check warning on line 6 in integrations/sdks/speakeasy.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

integrations/sdks/speakeasy.mdx#L6

Did you really mean 'SDKs'?

## Speakeasy SDK Repository Changes

In your Speakeasy SDK repos, add the following to the `targets` section of your `.speakeasy/workflow.yaml` file to ensure code samples are automatically produced alongside SDK generations.

Check warning on line 10 in integrations/sdks/speakeasy.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

integrations/sdks/speakeasy.mdx#L10

Did you really mean 'repos'?

```yaml .speakeasy/workflow.yaml
targets:
Expand Down Expand Up @@ -45,7 +45,7 @@

![](/images/speakeasy-3.webp)

Finally, Add your `SPEAKEASY_API_KEY` as a repository secret to your Minlify repo under `Settings > Secrets & Variables > Actions`. Find the Speakeasy API key in the Speakeasy dashboard under the **API Keys** tab.

Check warning on line 48 in integrations/sdks/speakeasy.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

integrations/sdks/speakeasy.mdx#L48

Did you really mean 'Minlify'?

## Manual Set Up

Expand Down Expand Up @@ -94,4 +94,4 @@
speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }}
```

Finally, make sure you add your `SPEAKEASY_API_KEY` as a repository secret to your Minlify repo under `Settings > Secrets & Variables > Actions`. Find the Speakeasy API key in the Speakeasy dashboard under the **API Keys** tab.

Check warning on line 97 in integrations/sdks/speakeasy.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

integrations/sdks/speakeasy.mdx#L97

Did you really mean 'Minlify'?
4 changes: 2 additions & 2 deletions navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ Anchors that strictly contain external links can be achieved using the `global`
{
"anchor": "Blog",
"icon": "pencil",
"href": "https://mintlify.com/blog"
"href": "/blog"
}
]
},
Expand Down Expand Up @@ -487,7 +487,7 @@ This way, you can create a very complex navigation structure that is easy to man
"anchors": [
{
"anchor": "Anchor 1",
"href": "https://mintlify.com/docs"
"href": "/docs"
}
]
},
Expand Down
2 changes: 1 addition & 1 deletion settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

To get started, you only need to specify `theme`, `name`, `colors.primary`, and `navigation`. Other fields are optional and you can add them as your documentation needs grow.

For the best editing experience, include the schema reference at the top of your `docs.json` file. This enables autocomplete, validation, and helpful tooltips in most code editors:

Check warning on line 16 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L16

Did you really mean 'tooltips'?

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

One of the following: `mint`, `maple`, `palm`, `willow`, `linden`, `almond`.

See [Themes](themes) for more information.
See [Themes](/customization/themes) for more information.

</ResponseField>

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

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
Font family, such as "Open Sans", "Playfair Display".

Check warning on line 161 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L161

Did you really mean 'Playfair'?
</ResponseField>
<ResponseField name="weight" type="number">
Font weight, such as 400 or 700. Variable fonts support precise weights such as 550.
Expand Down Expand Up @@ -263,12 +263,12 @@

### Structure

<ResponseField name="navbar" type="object">

Check warning on line 266 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L266

Did you really mean 'navbar'?
Navigation bar items.

<Expandable title="Navbar">
<ResponseField name="links" type="array of object">
Links to display in the navbar

Check warning on line 271 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L271

Did you really mean 'navbar'?

<Expandable title="Links">
<ResponseField name="label" type="string" required>
Expand Down Expand Up @@ -306,7 +306,7 @@

<Expandable title="Navigation">
<ResponseField name="global" type="object">
Global navigation elements that appear accross all pages and sections.

Check warning on line 309 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L309

Did you really mean 'accross'?

<Expandable title="Global">
<ResponseField name="languages" type="array of object">
Expand Down Expand Up @@ -540,7 +540,7 @@
Contextual menu for AI-optimized content and integrations.

<Expandable title="Contextual">
<ResponseField name="options" type="array of &quot;copy&quot; | &quot;view&quot; | &quot;chatgpt&quot; | &quot;claude&quot;" required>

Check warning on line 543 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L543

Did you really mean 'chatgpt'?

Check warning on line 543 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L543

Did you really mean 'claude'?
Actions available in the contextual menu. The first option appears as the default.
- `copy`: Copy the current page as Markdown to the clipboard.
- `view`: View the current page as Markdown in a new tab.
Expand All @@ -559,7 +559,7 @@

### API Configurations

<ResponseField name="api" type="object">

Check warning on line 562 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L562

Did you really mean 'api'?
API documentation and interactive playground settings.

<Expandable title="Api">
Expand Down Expand Up @@ -978,7 +978,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 981 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L981

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1021,7 +1021,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1024 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1024

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1030,8 +1030,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1033 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1033

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1034 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1034

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down Expand Up @@ -1152,7 +1152,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 1155 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1155

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1195,7 +1195,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1198 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1198

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1204,8 +1204,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1207 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1207

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1208 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1208

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down Expand Up @@ -1290,10 +1290,10 @@
{
"dropdown": "Documentación",
"icon": "book",
"description": "Cómo usar el producto de Example Co.",

Check warning on line 1293 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1293

Did you really mean 'usar'?

Check warning on line 1293 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1293

Did you really mean 'producto'?
"pages": [
{
"group": "Comenzando",

Check warning on line 1296 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1296

Did you really mean 'Comenzando'?
"pages": ["es/index", "es/quickstart"]
},
{
Expand All @@ -1313,7 +1313,7 @@
{
"dropdown": "Changelog",
"icon": "history",
"description": "Actualizaciones y cambios",

Check warning on line 1316 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1316

Did you really mean 'Actualizaciones'?

Check warning on line 1316 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1316

Did you really mean 'cambios'?
"pages": ["es/changelog"]
}
]
Expand Down Expand Up @@ -1341,7 +1341,7 @@
"footer": {
"socials": {
"x": "https://x.com/example",
"linkedin": "https://www.linkedin.com/company/example",

Check warning on line 1344 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1344

Did you really mean 'linkedin'?
"github": "https://github.com/example",
"slack": "https://example.com/community"
},
Expand Down Expand Up @@ -1384,7 +1384,7 @@
},
"integrations": {
"ga4": {
"measurementId": "G-XXXXXXXXXX"

Check warning on line 1387 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1387

Did you really mean 'measurementId'?
},
"koala": {
"publicApiKey": "pk_example_key_123"
Expand All @@ -1393,8 +1393,8 @@
"enabled": true
},
"cookies": {
"key": "example_cookie_key",

Check warning on line 1396 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1396

Did you really mean 'example_cookie_key'?
"value": "example_cookie_value"

Check warning on line 1397 in settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

settings.mdx#L1397

Did you really mean 'example_cookie_value'?
}
},
"contextual": {
Expand Down
Loading