# 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.
- [Reusable Snippets](https://documentation.ai/docs/write-and-publish/snippets.md): Create reusable Markdown text and React component snippets once, insert them across pages, and keep shared documentation synchronized through the web or code editor.
- [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 uploading and embedding videos and iframes using the editor UI and the Video / Iframe components.
- [Files](https://documentation.ai/docs/components/files.md): Reference for linking PDFs, documents, spreadsheets, audio, archives, and other downloadable files using the File slash command and Markdown links.
- [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.
- [Real-Time Collaboration](https://documentation.ai/docs/write-and-publish/collaboration.md): Edit documentation together in real time with inline comments, mentions, and notifications directly in the web editor.
- [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.
- [Media Library](https://documentation.ai/docs/write-and-publish/media-library.md): Upload, insert, reuse, replace, and delete images, videos, and files in your documentation, from the web editor or from a Git repository.
- [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.
- [Localization](https://documentation.ai/docs/organize/localization.md): Set up multi-language documentation with the languages dimension so readers can switch languages and see the right content tree.
- [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
- [Metadata](https://documentation.ai/docs/seo-and-geo/metadata.md): Control page-level SEO metadata and social sharing previews with automatic defaults and frontmatter overrides for titles, images, and URLs.
- [Robots.txt](https://documentation.ai/docs/seo-and-geo/robots-txt.md): Control search engine indexing and link following for your Documentation.AI site, then verify the published robots.txt configuration.
- [llms.txt](https://documentation.ai/docs/seo-and-geo/llms-txt.md): Make your documentation easier for AI models to discover and understand with an automatically generated llms.txt file.
- [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 CSS](https://documentation.ai/docs/customize/custom-css.md): Add custom stylesheets to override default styles, target specific components, and fine-tune your site's visual design.
- [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 Servers](https://documentation.ai/docs/ai/mcp-servers.md): Compare the Reader MCP Server and the Authoring MCP Server, and choose the right one for reading published docs or authoring them.
- [Reader MCP Server](https://documentation.ai/docs/ai/reader-mcp-server.md): Give AI agents read-only MCP access to your published documentation, including private and gated sites, so readers can search and reference your docs from ChatGPT, Claude, Cursor, and other MCP clients.
- [Authoring MCP Server](https://documentation.ai/docs/ai/authoring-mcp-server.md): Connect AI agents to Documentation.AI for read/write documentation workflows, authoring, review, and deployment tasks.
- [Page Actions](https://documentation.ai/docs/ai/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.
- [GitLab Integration](https://documentation.ai/docs/integrations/gitlab.md): Connect a GitLab project as your documentation source repository, with support for self-hosted instances, auto-deploy on push, and token management.
- [Confluence Integration](https://documentation.ai/docs/integrations/confluence.md): Connect Confluence as a context source for the AI Documentation Agent to search pages with CQL, read page content, and keep your docs aligned with your team's wiki.
- [Jira Integration](https://documentation.ai/docs/integrations/jira.md): Connect Jira as a context source for the AI Documentation Agent to search issues with JQL, read issue details, and keep your docs aligned with what your engineering team is building.
- [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): Read and update your documentation, publish deployments, and pull analytics 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.
- [Deploy the live site](https://documentation.ai/docs/api-reference/post-deploy.md): Republishes the deployment branch as it currently stands. Commits nothing.

Use it when content reached the branch some other way, or when an OpenAPI specification you reference by URL changed on its own host — nothing changed in Git, so nothing triggered a rebuild.

Requires editor or admin role.
- [Deploy a preview](https://documentation.ai/docs/api-reference/post-deploy-preview.md): Publishes a branch to its own preview URL. The live site is untouched.

Requires editor or admin role. Returns `403` if your plan does not include preview deployments.
- [List deployments](https://documentation.ai/docs/api-reference/get-deployments.md): Returns recent deployments for this documentation project, newest first.
- [Get deployment status](https://documentation.ai/docs/api-reference/get-deployments-deploymentid.md): Returns the current state of a single deployment. Use this to poll a deployment started by `POST /deploy` or `POST /deploy/preview` until its status reaches `ready` or `error`.
- [Traffic totals](https://documentation.ai/docs/api-reference/get-analytics-overview.md): Total page views and distinct sessions for a date range. Session count is distinct across the whole range, so it cannot be recovered by summing the daily series from `/analytics/traffic`.
- [Daily traffic](https://documentation.ai/docs/api-reference/get-analytics-traffic.md): Page views and sessions per day. Days with no traffic are returned as zeroes, so the series always covers every day in the range and can be charted without gap handling.
- [Most viewed pages](https://documentation.ai/docs/api-reference/get-analytics-pages.md): Pages ranked by view count, highest first. This is a top-N list: it takes a `limit` but cannot be paged, and returns no total.
- [Traffic sources](https://documentation.ai/docs/api-reference/get-analytics-referrers.md): Referrers ranked by page views, highest first. Values are reported exactly as received, with `(direct)` for visits that carried no referrer. This is a top-N list: it takes a `limit` but cannot be paged.
- [Feedback by page](https://documentation.ai/docs/api-reference/get-analytics-feedback.md): Rating totals with one row per page, so you can find the pages readers are least happy with.

The `summary` block covers the whole date range, not just the rows returned. To read the actual written comments for a page, use `/analytics/feedback/comments`.
- [Written feedback for a page](https://documentation.ai/docs/api-reference/get-analytics-feedback-comments.md): Individual feedback entries for one page, newest first. Only entries that included written text are returned, so a page with ratings but no comments returns an empty list and a total of zero.
- [AI assistant questions](https://documentation.ai/docs/api-reference/get-analytics-ai-questions.md): Questions asked of the AI assistant, newest first.

Set `maxConfidence` to surface the answers the assistant was least sure of. These are the clearest signal of gaps in your documentation. Questions with no confidence score are left out when you use that filter, since there is nothing to compare against the threshold.
- [Ratings on AI answers](https://documentation.ai/docs/api-reference/get-analytics-ai-answer-feedback.md): Thumbs up and down left on individual AI answers, newest first. The `summary` block covers the whole date range, not just the returned page of results.
- [Daily AI question volume](https://documentation.ai/docs/api-reference/get-analytics-ai-volume.md): Questions asked and distinct sessions per day. Days with no questions are returned as zeroes, so the series always covers every day in the range.
- [Search summary](https://documentation.ai/docs/api-reference/get-analytics-search.md): Total searches, sessions, no-result rate, and click-through rate for a date range. Returns zeroes when the range contains no search activity.
- [Daily search volume](https://documentation.ai/docs/api-reference/get-analytics-search-volume.md): Searches and sessions per day. Days with no searches are returned as zeroes, so the series always covers every day in the range.
- [Popular search queries](https://documentation.ai/docs/api-reference/get-analytics-search-queries.md): Search queries ranked by frequency, highest first. Set noResultsOnly to true to return only queries that returned zero results, which is the fastest way to find content gaps.
- [Per-page search performance](https://documentation.ai/docs/api-reference/get-analytics-search-results.md): Pages ranked by search activity, showing where searches most often produce no results. Use this to find pages where content or discoverability needs improvement.

## 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.