Skip to content

Commit 654d533

Browse files
authored
Task based IA (#1353)
* implement task-based IA * rearrange pages * tag examples * add cookbook example * add a components menu * rename cookbook to guides * fix docs.json after adding translations * prettier docs.json * move content to Guides * move GEO page to guides * draft of ai-native page * update body with info on reading/distributing * copy edits * 💅 * move guides above API reference * remove CLI sidebarTitle * update organization * remove tags * remove guides icons * Update ai-native.mdx * Update ai-native.mdx * copyedits * 💅 * even number of cards * update discovering section * remove components tab * remove icons * remove icon * add group level icons * update Get started group * Update organize group * update customize group * update create content group * shorten URLs * update API group * update deploy group * update optimize and guides groups * set up redirects * update links * add pdf page * add missing icons * remove default expanded state * update docs.json
1 parent b30b4f1 commit 654d533

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

88 files changed

+461
-298
lines changed

ai-native.mdx

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: "AI-native"
3+
description: "Learn how AI enhances reading, writing, and discovering your documentation"
4+
---
5+
6+
When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. Your content provides the context for these AI-native features to improve the experiences of reading, writing, and discovering your documentation.
7+
8+
## What makes your documentation AI-native
9+
10+
### Reading
11+
12+
In addition to reading individual pages, users can chat with the [assistant](/ai/assistant) in your documentation for immediate answers to their questions and links to relevant content. The assistant helps guide users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message) to extend where users can access your documentation.
13+
14+
### Writing
15+
16+
The [agent](/ai/agent) helps you write and maintain documentation. It creates pull requests with proposed changes based on your prompts, pull requests, and Slack threads. Add the agent to your Slack workspace so that anyone on your team can help maintain your documentation by chatting with the agent. Or embed the agent into custom apps via the [API](/api-reference/agent/create-agent-job).
17+
18+
Configure popular tools like [Cursor](/guides/cursor), [Claude Code](/guides/claude-code), and [Windsurf](/guides/windsurf) to reference the Mintlify schema, your style guide, and best practices.
19+
20+
### Discovering
21+
22+
Your site is automatically optimized for AI tools and search engines to help users discover your documentation. All pages are sent as Markdown to AI agents instead of HTML, which helps these tools process your content faster and use fewer tokens. Every page is also available to view as Markdown by appending `.md` to the URL.
23+
24+
Mintlify hosts `llms.txt` and `llms-full.txt` files for your documentation. These industry-standard files help LLMs index your documentation and respond efficiently with relevant information to user queries.
25+
26+
Your documentation site also hosts an MCP server that lets users connect your documentation directly to their AI tools for up to date information about your product directly where they want it.
27+
28+
Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search understands user intent rather than just matching keywords. And if a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required.
29+
30+
## Enable AI features
31+
32+
Select any of the following cards for more information.
33+
34+
<CardGroup cols={2}>
35+
<Card title="Assistant" icon="bot-message-square" href="/ai/assistant">
36+
Configure the assistant to search external sites or direct people to your support team if it can't answer their questions.
37+
</Card>
38+
<Card title="Agent" icon="pen-line" href="/ai/agent">
39+
Add the agent to your Slack workspace or embed it into custom apps to have it help write and update your documentation.
40+
</Card>
41+
<Card title="Contextual menu" icon="sparkles" href="/ai/contextual-menu">
42+
Add a menu to pages that lets users query AI tools, connect to your MCP server, and copy pages as context with one click.
43+
</Card>
44+
<Card title="MCP integration" icon="plug" href="/ai/model-context-protocol">
45+
Your site has a hosted MCP server that lets users connect your documentation directly to their AI tools. Make your users aware of your MCP server and how to connect to it.
46+
</Card>
47+
</CardGroup>

ai/agent.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "Agent"
33
description: "The agent helps you write and maintain documentation"
4-
icon: "pen-line"
54
---
65

76
<Info>

guides/assistant.mdx renamed to ai/assistant.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "Assistant"
33
description: "Help users succeed with your product and find answers faster"
4-
icon: "bot"
54
---
65

76
<Info>
@@ -114,7 +113,7 @@ Structure your documentation to help the assistant provide accurate, relevant an
114113
- Provide sufficient conceptual content about features and procedures.
115114
- Include examples and use cases.
116115
- Cross-reference related topics.
117-
- Add [hidden pages](/guides/hidden-pages) with additional context that users don't need, but the assistant can reference.
116+
- Add [hidden pages](/organize/hidden-pages) with additional context that users don't need, but the assistant can reference.
118117
</Card>
119118

120119
## Exporting and analyzing queries

ai/contextual-menu.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "Contextual menu"
33
description: "Add one-click AI integrations to your docs"
4-
icon: "square-menu"
54
---
65

76
import { PreviewButton } from "/snippets/previewbutton.jsx"

ai/llmstxt.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "llms.txt"
33
description: "Make your content easier for LLMs to read and index"
4-
icon: "file-code"
54
---
65

76
import { PreviewButton } from "/snippets/previewbutton.jsx"

ai/markdown-export.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "Markdown export"
33
description: "Quickly get Markdown versions of pages"
4-
icon: "file-text"
54
---
65

76
import { PreviewButton } from "/snippets/previewbutton.jsx"

ai/model-context-protocol.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "Model Context Protocol"
33
description: "Let users access your docs and APIs through their favorite AI tools"
4-
icon: "audio-waveform"
54
keywords: ["mcp"]
65
---
76

ai/slack-app.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
title: "Slack app"
33
description: "Add a bot that searches your docs to answer questions in your Slack workspace"
4-
icon: "slack"
54
---
65

76
<Info>
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)