Skip to content
Open
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
3 changes: 2 additions & 1 deletion api-playground/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Playground"
title: "Interactive API playground"
sidebarTitle: "Playground"
description: "Let developers test API endpoints directly in your documentation with an interactive playground that sends real requests and shows responses."
keywords: ["interactive", "API", "endpoint testing", "live API requests", "request builder"]
boost: 3
Expand Down
3 changes: 2 additions & 1 deletion api-playground/websocket-playground.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Playground"
title: "WebSocket API playground"
sidebarTitle: "Playground"
description: "Add interactive WebSocket playgrounds to your documentation so users can test real-time connections, send messages, and view event streams."
asyncapi: "/asyncapi.yaml channelOne"
---
3 changes: 2 additions & 1 deletion api/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Introduction"
title: "Mintlify REST API introduction"
sidebarTitle: "Introduction"
description: "Use the Mintlify REST API to trigger deployments, embed an AI assistant, export analytics data, and manage documentation programmatically."
keywords: ["REST API", "endpoints", "API keys"]
boost: 3
Expand All @@ -7,7 +8,7 @@

The Mintlify REST (Representational State Transfer) API enables you to programmatically interact with your documentation, trigger updates, embed AI-powered chat experiences, and export analytics data.

## Endpoints

Check warning on line 11 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L11

Use 'endpoints?' instead of 'Endpoints'.

- [Trigger update](/api/update/trigger): Trigger an update of your site when desired.
- [Get update status](/api/update/status): Get the status of an update and other details about your docs.
Expand Down
3 changes: 2 additions & 1 deletion components/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Overview"
title: "Components overview"
sidebarTitle: "Overview"
description: "Browse the full Mintlify component library for layout, emphasis, API documentation, and navigation elements available in your MDX pages."
keywords:
["MDX components", "documentation components", "UI components", "components"]
Expand Down Expand Up @@ -33,7 +34,7 @@
## Draw attention

<Card
title="Callouts"

Check warning on line 37 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L37

Use 'callouts?' instead of 'Callouts'.
icon="message-square-warning"
href="/components/callouts"
>
Expand Down Expand Up @@ -116,8 +117,8 @@

<Card
title="Mermaid diagrams"
icon="git-branch"

Check warning on line 120 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L120

Use 'Git' instead of 'git'.
href="/components/mermaid-diagrams"

Check warning on line 121 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L121

Use 'Mermaid' instead of 'mermaid'.
>
Create flowcharts, sequence diagrams, and more.
</Card>
Expand Down
3 changes: 2 additions & 1 deletion deploy/docs-subpath.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Overview"
title: "Host docs on a /docs subpath"
sidebarTitle: "Overview"
description: "Host your Mintlify documentation at a /docs subpath on your main domain using Cloudflare Workers, Vercel rewrites, or an nginx reverse proxy."
keywords: ["subpath routing", "/docs setup"]
boost: 3
Expand Down
3 changes: 2 additions & 1 deletion index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Introduction"
title: "Mintlify documentation"
sidebarTitle: "Introduction"
description: "Mintlify is an AI-native documentation platform built for developers, with beautiful defaults, interactive API playgrounds, and smart search."
mode: "frame"
keywords: ["overview", "platform", "getting started", "features"]
Expand All @@ -8,9 +9,9 @@

export const HeroCard = ({ filename, title, description, href }) => {
return (
<a className="group cursor-pointer pb-8" href={href}>

Check warning on line 12 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L12

Use 'classnames?' instead of 'className'.
<img
src={`https://raw.githubusercontent.com/mintlify/docs/refs/heads/main/images/hero/${filename}.png`}

Check warning on line 14 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L14

Use 'PNG' instead of 'png'.
className="block dark:hidden pointer-events-none group-hover:scale-105 transition-all duration-100"
/>
<img
Expand All @@ -22,8 +23,8 @@
</h3>
<span className="mt-1.5">{description}</span>
</a>
);

Check warning on line 26 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L26

Use semicolons judiciously.
};

Check warning on line 27 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L27

Use semicolons judiciously.

<div className="relative">
<div className="absolute -top-14 left-0 right-0 opacity-80">
Expand Down
Loading