# Documentation.AI

## Guides

- [Documentation.AI](https://documentation.ai/docs/getting-started/introduction.md): AI-native documentation platform to help teams create, maintain, and publish rich documentation and knowledge bases with built-in AI agents.
- [Core Concepts](https://documentation.ai/docs/getting-started/core-concepts.md): An overview of the core concepts behind Documentation.AI
- [Quickstart](https://documentation.ai/docs/getting-started/quickstart.md): Create, customize, and publish your first Documentation.AI site in minutes.
- [Web Editor](https://documentation.ai/docs/write-and-publish/web-editor.md): Create, edit, and publish documentation directly in your browser with the Documentation.AI web editor
- [Code Editor](https://documentation.ai/docs/write-and-publish/code-editor.md): Use Git-based workflows and MDX in your preferred code editor to write, organize, and publish documentation with Documentation.AI.
- [Components](https://documentation.ai/docs/components/components.md): Explore the full library of Documentation.AI components for building rich, interactive documentation pages.
- [Headings and Text](https://documentation.ai/docs/components/heading-and-text.md): Reference for headings, paragraphs, inline styles, links, and spacing using both the editor UI and MDX.
- [Lists and Tables](https://documentation.ai/docs/components/lists-and-tables.md): Reference for creating ordered lists, unordered lists, nested lists, and tables using both the editor UI and MDX.
- [Card](https://documentation.ai/docs/components/card.md): Reference for creating interactive cards with icons, images, and call-to-action buttons using both the editor UI and the Card component.
- [Columns](https://documentation.ai/docs/components/columns.md): Reference for creating responsive grid layouts using the Columns component.
- [Images](https://documentation.ai/docs/components/images.md): Reference for adding images using the editor UI and the Image component.
- [Videos and iframes](https://documentation.ai/docs/components/videos-and-iframes.md): Reference for embedding videos and iframes using the editor UI and the Video / Iframe components.
- [Code blocks and groups](https://documentation.ai/docs/components/code-blocks-and-groups.md): Display inline code and code blocks with syntax highlighting, line highlighting, focus effects, and tabbed interfaces for multiple examples.
- [Mermaid Diagrams](https://documentation.ai/docs/components/mermaid.md): Reference for creating interactive diagrams using Mermaid syntax with zoom and fullscreen capabilities.
- [Callout](https://documentation.ai/docs/components/callout.md): Reference for displaying highlighted information and alerts using the Callout component.
- [Expandables](https://documentation.ai/docs/components/expandables.md): Reference for creating collapsible content sections using the editor UI and the Expandable / ExpandableGroup components.
- [Steps](https://documentation.ai/docs/components/steps.md): Display sequential instructions or processes with numbered or icon-based steps and connecting lines.
- [Tabs](https://documentation.ai/docs/components/tabs.md): Organize content into tabbed interfaces with optional icons and smooth animated transitions.
- [Board](https://documentation.ai/docs/components/board.md): Reference for creating kanban-style layouts with the Board component, including visual editing, MDX syntax, card attributes, and column colors.
- [Collection List](https://documentation.ai/docs/components/collection-list.md): Reference for the CollectionList component that displays direct children of a navigation node as cards, accordions, lists, or links.
- [Collection Content](https://documentation.ai/docs/components/collection-content.md): Reference for the CollectionContent component that displays the full nested tree under a navigation node as a collapsible accordion structure.
- [Update](https://documentation.ai/docs/components/update.md): Display changelog entries, version updates, and product announcements with labeled sections and timeline layouts.
- [Param Field](https://documentation.ai/docs/components/paramfield.md): Reference for documenting API parameters with location badges, types, and status indicators.
- [Response Field](https://documentation.ai/docs/components/responsefield.md): Reference for documenting API response fields with types, requirements, and status indicators.
- [API Components](https://documentation.ai/docs/components/api-components.md): Reference for Request and Response components that automatically display in the right panel for API documentation.
- [Branches and previews](https://documentation.ai/docs/write-and-publish/branches-and-previews.md): Work safely in separate branches, review preview versions of your site, and merge or publish changes with the right workflow for your team.
- [Using Cursor](https://documentation.ai/docs/write-and-publish/cursor.md): Configure Cursor to be your documentation writing assistant
- [Using Claude Code](https://documentation.ai/docs/write-and-publish/claude-code.md): Configure Claude Code to be your documentation writing assistant
- [Helpful Prompts](https://documentation.ai/docs/write-and-publish/prompts.md): Ready-to-use AI prompts for writing exceptional technical documentation with Documentation.AI
- [Organize documentation structure](https://documentation.ai/docs/organize/overview.md): Understand the optional Dimensions → Views → Content model and how to plan a maintainable documentation structure in Documentation.AI.
- [Dimensions](https://documentation.ai/docs/organize/dimensions.md): Plan and configure products, versions, and languages as dimensions for organized, multi-context documentation in Documentation.AI.
- [Views](https://documentation.ai/docs/organize/views.md): Understand views (tabs and dropdowns), how they relate to dimensions and content, and how to choose and manage navigation patterns in the Web Editor.
- [Groups](https://documentation.ai/docs/organize/groups.md): Understand how Groups organize pages in the sidebar, when to use them, and how they differ from dropdowns and page-level grouping.
- [Pages](https://documentation.ai/docs/organize/pages.md): Understand how pages work as the building blocks of your docs, how to add them in the Web Editor, and how to keep their slugs and paths stable over time.
- [Customize Colors and Typography](https://documentation.ai/docs/customize/colors-and-typography.md): Fine-tune your documentation site's visual appearance by customizing brand colors, text colors, and typography for optimal readability and brand consistency.
- [Set Up Navigation and Sidebar](https://documentation.ai/docs/customize/navigation-and-sidebar.md): Create an organized navigation structure for your documentation site using the optimal hierarchy for your content and users.
- [Set Up Header and Navbar](https://documentation.ai/docs/customize/header-and-navbar.md): Add action buttons and navigation links to your documentation site's header to guide users to key actions and resources.
- [Set Up Site Branding](https://documentation.ai/docs/customize/branding.md): Add your logos, colors, and visual identity to create a branded documentation site that matches your company's look and feel.
- [Templates](https://documentation.ai/docs/customize/templates.md): Choose and customize documentation templates for your site
- [Robots.txt and llms.txt](https://documentation.ai/docs/seo-and-geo/robots-txt-and-llm-txt.md): Configure robots.txt and llms.txt for your Documentation.AI site, control indexing and following, and verify the published files.
- [Sitemap](https://documentation.ai/docs/seo-and-geo/sitemap.md): Configure and control sitemap.xml generation for your Documentation.AI site, including Site Config options, JSON config keys, and common issues.
- [Custom Domain Setup](https://documentation.ai/docs/customize/custom-domain.md): Connect your own domain to your documentation site for a professional, branded experience.
- [Custom Subpath Setup Overview](https://documentation.ai/docs/customize/custom-subpath/overview.md): Deploy your documentation at a custom subpath like yoursite.com/docs using reverse proxy configuration.
- [Vercel Subpath Setup](https://documentation.ai/docs/customize/custom-subpath/vercel.md): Host documentation at a custom subpath using Vercel rewrites configuration.
- [Cloudflare Workers Subpath Setup](https://documentation.ai/docs/customize/custom-subpath/cloudflare.md): Host documentation at a custom subpath like yoursite.com/docs using a Cloudflare Worker with multi-route proxying and SEO file rewrites.
- [AWS Route 53 & CloudFront Subpath Setup](https://documentation.ai/docs/customize/custom-subpath/aws.md): Host documentation at a custom subpath using AWS Route 53 and CloudFront for enterprise-grade infrastructure.
- [Redirects](https://documentation.ai/docs/customize/redirects-and-rewrites.md): Configure URL redirects to manage page moves, URL changes, and legacy paths in your documentation site.
- [Custom Scripts](https://documentation.ai/docs/customize/custom-scripts.md): Add custom JavaScript snippets to your documentation site for analytics, widgets, or any custom functionality not covered by built-in integrations.
- [Cookie Consent](https://documentation.ai/docs/customize/cookie-consent.md): Set up cookie consent to control when integrations, custom scripts, and telemetry load on your documentation site. Works with any consent management platform (CMP).
- [Access Control](https://documentation.ai/docs/customize/access-control/overview.md): Control who can view your documentation with flexible access control options.
- [Password Authentication](https://documentation.ai/docs/customize/access-control/password.md): Protect your documentation with a shared password.
- [JWT Authentication](https://documentation.ai/docs/customize/access-control/jwt.md): Authenticate users with JSON Web Tokens and control access with roles.
- [OAuth 2.0 Authentication](https://documentation.ai/docs/customize/access-control/oauth.md): Integrate with your identity provider using OAuth 2.0 or OpenID Connect.
- [Site Configuration](https://documentation.ai/docs/customize/site-configuration.md): Site configuration using documentation.json options and examples.
- [Page Configuration](https://documentation.ai/docs/customize/page-configuration.md): Reference for configuring page-level metadata using MDX front matter, including title, description, SEO properties, and structured data.
- [OpenAPI Spec Import](https://documentation.ai/docs/api-documentation-and-playground/openapi-import.md): Import OpenAPI 3.0+ specifications to automatically generate comprehensive API documentation with interactive examples.
- [Organize API Reference](https://documentation.ai/docs/api-documentation-and-playground/organize-api-reference.md): Structure your API documentation using tags, groups, and custom ordering for optimal developer experience and navigation.
- [Interactive Playground Setup](https://documentation.ai/docs/api-documentation-and-playground/interactive-playground-setup.md): Configure interactive API testing environments with authentication, request customization, and live response previews.
- [Code Generation](https://documentation.ai/docs/api-documentation-and-playground/code-generation.md): Automatically generate client code examples in multiple programming languages from OpenAPI specifications with customizable templates.
- [AI Documentation Agent](https://documentation.ai/docs/ai/ai-documentation-agent.md): Learn how to use the AI Documentation Agent in the Web Editor to draft, edit, and keep docs aligned with your code using GitHub context.
- [Workflows](https://documentation.ai/docs/ai/workflows.md): Automate documentation tasks with AI workflows, including setup requirements, templates, triggers, run history, and current limitations.
- [AI Assistant](https://documentation.ai/docs/ai/ai-assistant.md): AI Assistant helps users get docs-aware answers with citations, follow-up prompts, customization controls, analytics, and bot protection.
- [MCP Server](https://documentation.ai/docs/ai/mcp-server.md): Overview of Documentation.AI MCP servers for read-only documentation access and authoring workflows.
- [Docs MCP Server](https://documentation.ai/docs/ai/docs-mcp-server.md): Connect AI tools to Documentation.AI docs for read-only access to published documentation.
- [Authoring MCP Server](https://documentation.ai/docs/ai/authoring-mcp-server.md): Connect AI tools to Documentation.AI for read/write documentation workflows, authoring, review, and deployment tasks.
- [Page Actions](https://documentation.ai/docs/page-actions.md): Configure quick AI-friendly actions in the sidebar so readers can copy or open any page in external AI tools using optimized Markdown.
- [AI Credits](https://documentation.ai/docs/ai/ai-credits.md): How credits work, what affects cost, and real examples of credit usage for the AI Documentation Agent and AI Assistant.
- [Integrations and Workflows](https://documentation.ai/docs/integrations/overview.md): Connect analytics platforms, support widgets, and developer tools to your documentation site with zero-code configuration.
- [GitHub Integration](https://documentation.ai/docs/integrations/github.md): Connect the Documentation.AI GitHub App and add context repositories so the AI agent can use your code and commits while working on docs.
- [Google Tag Manager](https://documentation.ai/docs/integrations/google-tag-manager.md): Inject your Google Tag Manager container script across all documentation pages with zero-code setup.
- [Google Analytics](https://documentation.ai/docs/integrations/google-analytics.md): Track page views and events on your documentation site with Google Analytics 4.
- [PostHog](https://documentation.ai/docs/integrations/posthog.md): Track product analytics events on your documentation site with PostHog.
- [Amplitude](https://documentation.ai/docs/integrations/amplitude.md): Send analytics events from your documentation site to Amplitude.
- [Mixpanel](https://documentation.ai/docs/integrations/mixpanel.md): Track events on your documentation site with Mixpanel.
- [Segment](https://documentation.ai/docs/integrations/segment.md): Route analytics data from your documentation site through Segment.
- [Heap](https://documentation.ai/docs/integrations/heap.md): Track user interactions on your documentation site with Heap.
- [Plausible](https://documentation.ai/docs/integrations/plausible.md): Track page views on your documentation site with Plausible, a privacy-friendly analytics platform.
- [Fathom](https://documentation.ai/docs/integrations/fathom.md): Track site analytics on your documentation site with Fathom, a privacy-first analytics tool.
- [Pirsch](https://documentation.ai/docs/integrations/pirsch.md): Monitor web traffic on your documentation site with Pirsch, a privacy-friendly analytics platform.
- [Hotjar](https://documentation.ai/docs/integrations/hotjar.md): Understand user behavior on your documentation site with Hotjar heatmaps and session recordings.
- [Microsoft Clarity](https://documentation.ai/docs/integrations/clarity.md): Record heatmaps and session replays on your documentation site with Microsoft Clarity.
- [Clearbit](https://documentation.ai/docs/integrations/clearbit.md): Enrich visitor data on your documentation site with Clearbit.
- [LogRocket](https://documentation.ai/docs/integrations/logrocket.md): Session replay and error tracking for your documentation site with LogRocket.
- [Hightouch](https://documentation.ai/docs/integrations/hightouch.md): Send events from your documentation site to Hightouch for reverse ETL.
- [Intercom](https://documentation.ai/docs/integrations/intercom.md): Add the Intercom Messenger widget to your documentation for live chat and support.
- [Crisp](https://documentation.ai/docs/integrations/crisp.md): Add the Crisp live chat widget to your documentation site.
- [Overview & Insights](https://documentation.ai/docs/analytics/overview.md): Understand the different analytics we provide for your documentation and how they help you continuously improve it.

## API Reference

- [REST API](https://documentation.ai/docs/api-reference/overview.md): Programmatic access to read and update your documentation through the Documentation.AI REST API.
- [Get site configuration](https://documentation.ai/docs/api-reference/get-config.md): Returns the complete documentation.json file — the navigation tree, branding, SEO settings, and integrations.
- [Search documentation](https://documentation.ai/docs/api-reference/get-search.md): Performs a hybrid search combining semantic understanding and keyword matching across all indexed documentation pages.
- [List all pages](https://documentation.ai/docs/api-reference/get-pages.md): Returns every file in the documentation repository with its path and size in bytes.
- [Get page content](https://documentation.ai/docs/api-reference/get-pages-path.md): Returns the full content of a documentation page by its file path.
- [List branches](https://documentation.ai/docs/api-reference/get-branches.md): Returns all branches in the documentation repository.
- [Create a branch](https://documentation.ai/docs/api-reference/post-branches.md): Creates a new Git branch in the documentation repository. Requires editor or admin role.
- [Delete a branch](https://documentation.ai/docs/api-reference/post-branches-delete.md): Deletes a branch from the repository. The deployment branch cannot be deleted. Requires editor or admin role.
- [Merge branches](https://documentation.ai/docs/api-reference/post-branches-merge.md): Merges one branch into another. If the target branch is the deployment branch, this triggers a live deployment.
- [List pull requests](https://documentation.ai/docs/api-reference/get-pull-requests.md): Returns pull requests in the documentation repository, filtered by state.
- [Push file changes](https://documentation.ai/docs/api-reference/post-push.md): Creates, updates, or deletes documentation files in a single Git commit. Supports up to 20 operations per request. Pushing to the deployment branch triggers a live deployment. Requires editor or admin role.

## Changelog

- [Release Notes](https://documentation.ai/docs/changelog.md): Changes, fixes, and improvements across versions

## Roadmap

- [Roadmap](https://documentation.ai/docs/roadmap.md): See what's coming next for Documentation.AI

## Help Center

- [Contact Us](https://documentation.ai/docs/help/contact-us.md): Learn how to get product help, explore self‑serve resources, and reach the Documentation.AI team.
- [Community & Social Channels](https://documentation.ai/docs/help/community.md): Learn how to use Documentation.AI’s community spaces, social platforms, and informal support channels.