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
2 changes: 1 addition & 1 deletion agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
The agent is available on [Enterprise plans](https://mintlify.com/pricing?ref=agent) for anyone with access to your dashboard.
</Info>

The agent is an AI tool that creates pull requests with proposed changes to your documentation based on your prompts. When you send a request, the agent:
The agent is an AI tool that creates pull requests with proposed changes to your documentation based on your prompts. When you send a request, the agent does the following:

- **Researches**: Reads your existing documentation, any connected repositories, and relevant context.
- **Plans**: Creates a structured task list for complex documentation work.
Expand All @@ -34,7 +34,7 @@

## Where you can use the agent

- **Dashboard**: From any page in your dashboard, use the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) to open the agent panel. Or click **Ask agent** on the [Overview](https://dashboard.mintlify.com/) page.

Check warning on line 37 in agent/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/index.mdx#L37

Avoid first-person pronouns such as ' I '.
<Frame>
<img src="/images/agent/dashboard-light.png" alt="The agent panel open in the dashboard." className="block dark:hidden" />
<img src="/images/agent/dashboard-dark.png" alt="The agent panel open in the dashboard." className="hidden dark:block" />
Expand Down
6 changes: 3 additions & 3 deletions ai-native.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ description: "Learn how AI enhances reading, writing, and discovering your docum
keywords: ["AI","assistant","agent","llms.txt","MCP","llms-full.txt"]
---

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.
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 that improve the experiences of reading, writing, and discovering your documentation.

## What makes your documentation AI-native

### Reading

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/assistant/create-assistant-message) to extend where users can access your documentation.
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 guides users through your product with accurate information from your documentation. Embed the assistant into custom apps with the [API](/api/assistant/create-assistant-message) to extend where users can access your documentation.

### Writing

Expand All @@ -23,7 +23,7 @@ Configure popular tools like [Cursor](/guides/cursor), [Claude Code](/guides/cla

### Discovering

Your site is automatically optimized for AI tools and search engines to help users discover your documentation. All pages send their content 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.
Your site is automatically optimized for AI tools and search engines to help users discover your documentation. All pages send their content as Markdown to AI agents instead of HTML, helping 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.

Mintlify hosts `llms.txt` and `skill.md` files for your documentation. These industry-standard files help LLMs respond efficiently with relevant information to user queries and provide a list of capabilities for agents to use, so that users are more successful with your product.

Expand Down
2 changes: 1 addition & 1 deletion dashboard/audit-logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
| Field | Description |
| ----- | ----------- |
| Timestamp | Date and time when the action occurred |
| Actor | Email address of the user who performed the action |

Check warning on line 27 in dashboard/audit-logs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/audit-logs.mdx#L27

Use 'email' instead of 'Email'.
| Action | What action the user performed |
| Category | Type of resource affected |
| Outcome | Whether the action succeeded or failed |
Expand Down Expand Up @@ -62,4 +62,4 @@
1. Navigate to the [Audit log](https://dashboard.mintlify.com/settings/organization/audit-logs) page of your dashboard.
1. Optionally, apply filters to narrow down the logs you want to export.
1. Click **Export CSV**.
1. Mintlify sends you an email with a download link when the export is ready.
1. Mintlify sends you an email with a download link when the export is complete.
8 changes: 4 additions & 4 deletions guides/knowledge-base.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
keywords: ["knowledge base", "internal documentation", "private docs", "kb", "knowledge management", "knowledge capture"]
---

An internal knowledge base helps your team find answers and maintain a source of truth. If your team has information spread across different channels and platforms, people might find inaccurate or no information when they search for answers. A centralized knowledge base solves this by putting answers where everyone can find them and giving your team a specific place to record shared knowledge.
An internal knowledge base helps your team find answers and maintain a source of truth. If your team has information spread across different channels and platforms, people might find inaccurate or no information when they search for answers. A centralized knowledge base solves this by putting answers where everyone can find them and gives your team a specific place to record shared knowledge.

Mintlify provides the infrastructure for knowledge bases that your entire team can contribute to.

Expand Down Expand Up @@ -34,14 +34,14 @@
- **Topics and content**: Informs your navigation structure and content organization.
- **Current organization**: See how your content is currently organized and whether it matches your desired structure.
- **Content types**: Determine any content conversion requirements for text, PDFs, videos, and embedded content.
- **Metadata**: Identify any metadata to preserve like dates, authors, and tags.
- **Metadata**: Identify any metadata to preserve, such as dates, authors, and tags.
- **Access requirements**: Determine the best authentication approach for your knowledge base.

### Export your existing content

Most knowledge base platforms support exporting content in standard formats. The format you choose depends on your current platform and your priorities.

- Export to **Markdown** for the simplest migration to Mintlify. (recommended)

Check warning on line 44 in guides/knowledge-base.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/knowledge-base.mdx#L44

Use parentheses judiciously.
- Export to **HTML** if Markdown isn't available. You must convert your content to Markdown later.
- Export to **JSON or CSV** if you have structured metadata to preserve.

Expand Down Expand Up @@ -97,9 +97,9 @@

Determine who needs access to what content in your knowledge base.

If everyone should have access to the entire knowledge base, set up only [authentication](/deploy/authentication-setup).
If everyone should have access to the entire knowledge base, set up [authentication](/deploy/authentication-setup) only.

If you need to restrict access to certain content to specific users or groups, set up authentication with [group-based access control](/deploy/authentication-setup#control-access-with-groups).
If you need to restrict access to certain content for specific users or groups, set up authentication with [group-based access control](/deploy/authentication-setup#control-access-with-groups).

## Migrate your content

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

Configure the assistant from your [dashboard](https://dashboard.mintlify.com/products/assistant/settings):

- **Sample questions**: Add common questions like "how do I submit an expense report" or "what is the vacation policy" so people can get answers with one click.

Check warning on line 180 in guides/knowledge-base.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/knowledge-base.mdx#L180

Avoid first-person pronouns such as ' I '.
- **Search sites**: Include additional sites the assistant can search when answering questions.
- **Deflection email**: Set a support email for questions the assistant can't answer.

Expand Down