Skip to main content

Documentation index

The Documentation tab of the System screen. It manages the search index behind the in-product documentation — the help surfaced by the search and the assistant.

Like the geo/cloak databases, the index has two update modes:

  • Automatic updates — the index is pulled from the licensing server on a schedule; set how often with the Update every field (in hours).
  • Manual updates — the scheduler is off; the index updates only via the Update now button.
Who sees the mode switch and the button

The mode switch and the Update every field are shown to administrators only, and the Update now button only to a role that is allowed to run background jobs by hand. Anyone who can open this tab still sees the index status and the update history. The message column of that history, however, belongs to administrators alone: to everyone else the server sends that field empty, and the column is then dropped from the table entirely rather than shown as dashes.

Below are the Index status (chunk count, documentation date, vector dimensions and the embedding model) and the Update history, with the columns Time, Status, Trigger, Chunks, File size and Message.

A status line tells you whether documentation search is active, or off — for example when the instance has no OpenRouter key, when the index's embedding model differs from the instance's, or when the index is still empty.

What's next

On this page