-
Notifications
You must be signed in to change notification settings - Fork 208
Task based IA #1353
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.
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
Merged
Merged
Task based IA #1353
Changes from 22 commits
Commits
Show all changes
50 commits
Select commit
Hold shift + click to select a range
33f4532
implement task-based IA
ethanpalm ba17048
rearrange pages
ethanpalm 807061c
tag examples
ethanpalm 31e8279
add cookbook example
ethanpalm 80943b3
Merge branch 'main' into task-based-IA
ethanpalm 59e4eda
add a components menu
ethanpalm 77a8336
rename cookbook to guides
ethanpalm aee4ea7
Merge branch 'main' into task-based-IA
ethanpalm efb2973
fix docs.json after adding translations
ethanpalm 024fe78
prettier docs.json
ethanpalm acd894f
move content to Guides
ethanpalm 005907b
move GEO page to guides
ethanpalm 0a1e861
draft of ai-native page
ethanpalm 94081e9
update body with info on reading/distributing
ethanpalm 271a217
copy edits
ethanpalm 88e6f5f
💅
ethanpalm 95c6017
move guides above API reference
ethanpalm 536cb8a
remove CLI sidebarTitle
ethanpalm 5136178
update organization
ethanpalm 4a4a4a3
remove tags
ethanpalm 1f4762c
remove guides icons
ethanpalm a079083
Merge branch 'main' into task-based-IA
ethanpalm 954387e
Merge branch 'main' into task-based-IA
ethanpalm 43ddc1b
Update ai-native.mdx
ethanpalm f9fdf49
Update ai-native.mdx
ethanpalm cb0cd89
copyedits
ethanpalm 355c5cb
💅
ethanpalm 33bd18d
even number of cards
ethanpalm 450e9e2
update discovering section
ethanpalm ee50453
remove components tab
ethanpalm 24520bb
remove icons
ethanpalm 89112bf
remove icon
ethanpalm 1ad2ce9
add group level icons
ethanpalm f4532f7
update Get started group
ethanpalm 903573e
Update organize group
ethanpalm a2244d4
update customize group
ethanpalm 87910f7
update create content group
ethanpalm 2e42626
shorten URLs
ethanpalm 384f3db
update API group
ethanpalm f0aafd0
update deploy group
ethanpalm daa31c7
update optimize and guides groups
ethanpalm 5a08163
Merge branch 'main' into task-based-IA
ethanpalm 4c568e4
set up redirects
ethanpalm b730132
Merge branch 'main' into task-based-IA
ethanpalm 0635873
update links
ethanpalm 015cf34
Merge branch 'main' into task-based-IA
ethanpalm 865beaa
add pdf page
ethanpalm f7a4ea6
add missing icons
ethanpalm b2f631b
remove default expanded state
ethanpalm 0ec3e82
update docs.json
ethanpalm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
--- | ||
title: "AI-native docs" | ||
description: "Learn how AI enhances reading, writing, and distributing your docs" | ||
icon: "cpu" | ||
--- | ||
|
||
When you host your documentation on Mintlify, built-in AI features help your users find answers and your team maintain content more efficiently. These AI-native features analyze your docs to improve the experience of reading, writing, and distributing your docs. | ||
|
||
## What makes your docs AI-native | ||
|
||
### Content suggestions | ||
Users can chat with the assistant to get answers and links to relevant pages to guide them through using your product. Embed the assistant into custom apps with the [API](api-reference/assistant/create-assistant-message). | ||
|
||
If a user encounters a 404 error, your site suggests related pages to help them find what they're looking for. No configuration required. | ||
|
||
### Search-optimized | ||
Mintlify automatically hosts `llms.txt` and `llms-full.txt` files for your docs. These files are an industry standard that help LLMs index content. AI tools use these files to process the structure of your documentation and find content relevant to user queries. | ||
|
||
Mintlify also hosts an MCP server for your docs site that lets users connect your docs directly to their AI tools so that they have up to date information about your product directly where they want it. | ||
|
||
Full-text search and semantic understanding help users and AI tools find relevant information quickly. Search on your docs understands user intent rather than just matching keywords. | ||
|
||
### Structured content | ||
Your MDX pages generate semantic HTML with proper heading hierarchies, which makes it easy for AI tools to understand and reference your content. Every page is available as Markdown by appending `.md` to the page's URL. | ||
|
||
Page frontmatter—like titles, descriptions, and tags—provides context that helps AI tools understand the purpose and scope of each page. | ||
|
||
## Enable additional AI features | ||
|
||
Select any of the following cards for more information. | ||
|
||
<CardGroup cols={2}> | ||
<Card title="Assistant" icon="bot-message-square" href="/guides/assistant"> | ||
Configure the assistant to search external sites or direct people to your support team if it can't answer their questions. | ||
</Card> | ||
<Card title="Contextual menu" icon="sparkles" href="/ai/contextual-menu"> | ||
Add a menu to pages that lets users query AI tools, connect to your MCP server, and copy pages as context with one click. | ||
</Card> | ||
<Card title="MCP integration" icon="plug" href="/ai/model-context-protocol"> | ||
Your site has a hosted MCP server that lets users connect your docs directly to their AI tools. Make your users aware of your MCP server and how to connect to it. | ||
</Card> | ||
<Card title="Editor integrations" icon="code"> | ||
Configure [Claude Code](/guides/claude-code), [Cursor](/guides/cursor), or [Windsurf](/guides/windsurf) to help write, review and update your docs. | ||
</Card> | ||
</CardGroup> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.