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
4 changes: 2 additions & 2 deletions guides/assistant.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Assistant"
description: "Help users succeed with your product and find answers faster"
description: "Self-updating knowledge management with intelligent assistance for your users"
icon: "bot"
---

Expand All @@ -10,9 +10,9 @@

## 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 transforms your documentation into a self-updating knowledge management system. It answers questions about your documentation through natural language queries and is embedded directly in your documentation site, providing users with immediate access to contextual help while continuously learning from user interactions.

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 (mintlify) - 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 Down Expand Up @@ -56,7 +56,7 @@

Users can access the assistant in three ways:

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

Check warning on line 59 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L59

Did you really mean 'Ctrl'?
- **Assistant button** next to the search bar
<img
src="/images/assistant/assistant-button-light.png"
Expand All @@ -80,7 +80,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 83 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L83

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 @@ -89,7 +89,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 92 in guides/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/assistant.mdx#L92

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

Expand Down
4 changes: 2 additions & 2 deletions index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Introduction"
description: "Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers."
description: "Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for collaboration."
icon: "book-open"
mode: "custom"
---
Expand Down Expand Up @@ -42,7 +42,7 @@ export const HeroCard = ({ filename, title, description, href }) => {
</h1>

<div className="max-w-xl mx-auto px-4 mt-4 text-lg text-center text-gray-500 dark:text-zinc-500">
Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers.
Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for collaboration.
</div>

<div className="px-6 lg:px-0 mt-12 lg:mt-24 grid sm:grid-cols-2 gap-x-6 gap-y-4">
Expand Down
14 changes: 10 additions & 4 deletions quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "Quickstart"
description: "Deploy your documentation in minutes"
description: "Deploy your intelligent documentation platform in minutes"
icon: "rocket"
---

This quickstart guide shows you how to set up and deploy your documentation site in minutes.
This quickstart guide shows you how to set up and deploy your AI-native documentation site in minutes.

After completing this guide, you will have a live documentation site ready to customize and expand.
After completing this guide, you will have a live intelligent documentation platform ready to customize and expand with AI-powered features.

<Info>

Expand Down Expand Up @@ -216,8 +216,11 @@

## Next steps

Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:
Congratulations! You have successfully deployed your intelligent documentation platform with Mintlify. Here are suggested next steps to enhance your documentation:

<Card title="Enable AI-native features" icon="brain-circuit" href="/guides/assistant" horizontal>
Set up the AI assistant, llms.txt, and MCP to make your docs AI-ready for both users and LLMs.

Check warning on line 222 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L222

Did you really mean 'LLMs'?
</Card>
<Card title="Configure your global settings" icon="settings" href="settings" horizontal>
Configure site-wide styling, navigation, integrations, and more with the `docs.json` file.
</Card>
Expand All @@ -233,6 +236,9 @@
<Card title="Set up API references" icon="code" href="/api-playground/overview" horizontal>
Create interactive API references with OpenAPI and AsyncAPI specifications.
</Card>
<Card title="Enterprise features" icon="building" href="/advanced/dashboard/sso" horizontal>
Configure SSO, permissions, and compliance features for enterprise-grade security and access control.
</Card>

## Troubleshooting

Expand Down