Skip to content

docs: improve page titles for SEO uniqueness #5852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
Closed

docs: improve page titles for SEO uniqueness #5852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion api-playground/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Playground"
title: "API playground overview"
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
2 changes: 1 addition & 1 deletion api-playground/websocket-playground.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Playground"
title: "WebSocket 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"
---
2 changes: 1 addition & 1 deletion api/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Introduction"
title: "Mintlify REST API 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 +7,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 10 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L10 

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
2 changes: 1 addition & 1 deletion components/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Overview"
title: "MDX components 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 +33,7 @@
## Draw attention

<Card
title="Callouts"

Check warning on line 36 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L36 

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

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

Check warning on line 119 in components/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/index.mdx#L119 

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

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 'Mermaid' instead of 'mermaid'.
>
Create flowcharts, sequence diagrams, and more.
</Card>
Expand Down
2 changes: 1 addition & 1 deletion deploy/docs-subpath.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Overview"
title: "Host docs at a subpath"
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
Loading