The assistant is automatically enabled on Pro, Growth, and Enterprise plans.

​
About the assistant

The assistant answers questions about your documentation through natural language queries. It is embedded directly in your documentation site, providing users with immediate access to contextual help. The assistant uses agentic RAG (retrieval-augmented generation) with tool calling powered by Claude Sonnet 4. When users ask questions, the assistant:
  • Searches and retrieves relevant content from your documentation to provide accurate answers.
  • Cites sources and provides navigable links to take users directly to referenced pages.
  • Generates copyable code examples to help users implement solutions from your documentation.
You can view assistant usage through your dashboard to understand user behavior and documentation effectiveness. Export and analyze query data to help identify:
  • Frequently asked questions that might need better coverage.
  • Content gaps where users struggle to find answers.
  • Popular topics that could benefit from additional content.

​
Using the assistant

Users can access the assistant in two ways:
  • Keyboard shortcut: Command + I (Ctrl + I on Windows)
  • Assistant button next to the search bar Search bar and assistant button in light mode. Search bar and assistant button in dark mode.
Both methods open a chat panel on the right side of your docs. Users can ask any question and the assistant will search your documentation for an answer. If no relevant information is found, the assistant will respond that it cannot answer the question.

​
Making content AI ingestible

Structure your documentation to help the assistant provide accurate, relevant answers. Clear organization and comprehensive context benefit both human readers and AI understanding.

Structure and organization

  • Use semantic markup.
  • Write descriptive headings for sections.
  • Create a logical information hierarchy.
  • Use consistent formatting across your docs.
  • Include comprehensive metadata in page frontmatter.
  • Break up long blocks of text into shorter paragraphs.

Context

  • Define specific terms and acronyms when first introduced.
  • Provide sufficient conceptual content about features and procedures.
  • Include examples and use cases.
  • Cross-reference related topics.
  • Add hidden pages with additional context that users don’t need, but the assistant can reference.

​
Exporting and analyzing queries

Review and export queries from your dashboard to understand how people interact with your documentation and identify improvement opportunities. Some ways that analyzing queries can help you improve your documentation:
  • Identify content gaps where frequent queries receive insufficient answers.
  • Discover user behavior patterns and common information needs from themes and patterns in queries.
  • Prioritize high-traffic pages for accuracy and quality improvements.
You can explore queries from your dashboard, but to get more powerful insights we recommend exporting a CSV file of your queries, responses, and sources to analyze with your preferred AI tool.
  1. Navigate to the assistant page in your dashboard.
  2. Select Export to CSV.
  3. Analyze the exported data using your preferred tool.

Sample analysis prompts

  • Summarize the most common themes of the queries.
  • List any queries that had no sources cited.
  • Find patterns in unsuccessful interactions.