Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

AI Assistant

Holocron includes a built-in AI chat assistant that appears as a sidebar widget. Users can ask questions about your documentation and get answers based on the docs content.
To embed the chat on an external website (outside your docs site), see the Chat Widget page.

Enabling and disabling

The assistant is enabled by default. To disable it:
{
  "assistant": {
    "enabled": false
  }
}
When disabled, the sidebar widget, chat drawer, and mobile "Ask AI" button are hidden. The chat route still exists and returns 404 Assistant is disabled.

Suggested prompts

The empty chat screen shows a short pitch and up to three suggestion links. Clicking a suggestion submits it as a prompt. Customize them with assistant.suggestions:
{
  "assistant": {
    "suggestions": [
      "What is Acme?",
      "Show me the quickstart",
      "Search the docs for ..."
    ]
  }
}
A suggestion ending with ... is treated as open-ended: clicking it fills the chat input with the text (dots removed) and focuses it, so the user can complete the query before sending.
When suggestions is omitted, three defaults based on the site name are shown:
  • What is {site name}?
  • Guide me through the pages I should read first
  • Search the docs for ...

How it works

The assistant uses the hosted Holocron AI gateway to process questions. When deployed, the docs app sends the current page plus either inline docs in local development or a docs.zip URL in production, then streams the answer back into the chat UI.
Hosted chat uses Cloudflare Workers AI. Authenticated sites send HOLOCRON_KEY; unauthenticated requests use a temporary fallback with stricter IP rate limits. The default model is GLM 4.7 Flash.

What gets disabled

Setting enabled: false removes:
  • The sidebar chat widget
  • The chat drawer overlay
  • The mobile "Ask AI" floating button
  • Useful responses from /holocron-api/chat; the endpoint returns 404 while disabled

Skill loading

The hosted gateway can accept remote skill URLs, but the built-in docs assistant does not expose a docs.json setting for them yet. Today it answers from the current docs content and the docs zip payload.
Powered byHolocron