Guides - Mintlify

Documentation Index

Fetch the complete documentation index at: /docs/llms.txt

Use this file to discover all available pages before exploring further.

The guides in this section contain advice for creating documentation that helps your users succeed. Whether you’re starting from scratch or improving existing docs, these guides help you plan, write, and maintain your documentation. Above all else, consider your users’ needs and goals. Document what helps them use your product and get back to their tasks.

Topics

AI tools

Use AI-powered tools to accelerate your documentation workflow.

• Build an in-app assistant: Tutorial that teaches how to add an AI chat bot in a React app to help users find answers from your documentation.
• Configure automerge: Add the Mintlify GitHub App to a ruleset bypass list to enable automatic merging for automations.
• Use automations: Choose the right automation trigger, write effective instructions, and get consistent results from automated content maintenance.
• Claude Code, Codex, Cursor, Devin Desktop: Guides for using AI coding assistants to maintain documentation.
• GEO: Best practices for optimizing your documentation for AI search and answer engines.

API documentation

Create API documentation that lets users test and learn how to use your API, and is easy to maintain.

• Migrate from MDX to OAS: Move your API documentation from individual MDX pages to autogenerated pages from an OpenAPI specification.

Best practices

Make your documentation best in class.

• Accessibility: Make your docs accessible to as many users as possible.
• Content types: Choose the right format for tutorials, how-tos, references, and explanations.
• Content templates: Copy and modify templates for each content type.
• Custom page layouts: Use page modes and components to build landing pages and other custom layouts.
• Improve your docs: Use data and feedback to continuously improve your documentation.
• Internationalization: Set up multi-language documentation to reach global audiences.
• Linking: Create internal links, reference API endpoints, and maintain link integrity across your documentation.
• Maintenance: Keep your documentation accurate and up-to-date.
• Media: Add images, videos, and other media effectively while managing maintenance burden.
• Organize navigation: Design information architecture that works for your users.
• SEO: Optimize your docs for search engines.
• Style and tone: Write with a consistent voice.
• Understand your audience: Research and serve your users’ needs and goals.

Git workflows

Understand Git to get the most out of Mintlify and a docs-as-code approach to documentation.

• Git concepts: Learn the fundamentals of Git for documentation.
• Branches: Use branches to manage documentation changes.

Use cases

Learn how Mintlify supports different use cases and find a solution that works for you.

• Create developer documentation: Help your users get the most from your product or API with developer documentation that answers questions and gets people back to their main tasks.
• Create a knowledge base: Set up an internal knowledge base to consolidate information for your team, improve search, and reduce maintenance burden.
• Create a help center: Build a self-service help center that enables users to self-serve answers, reduces ticket volume, and improves customer satisfaction.
• Create a custom frontend: Use the Mintlify Astro integration to render your documentation with a fully custom frontend.

Where to start

[**New to documentation?**
Learn about content types to understand how to structure your docs.](/content/docs/guides/content-types/index.html)

[**Improving existing docs?**
Learn how to use metrics and feedback to make your docs better.](/content/docs/guides/improving-docs/index.html)

[**Working with a team?**
Learn Git workflows for collaborative documentation.](/content/docs/guides/git-concepts/index.html)