NAVIGATION
ELOWEN DOCUMENTATION Reference on GitHub ↗

Last updated: 24 September 2026

Plugin reference

Search This Manual

The bundled elowen-docs plugin (version 0.1.1) adds DocsSearch, which searches Elowen's shipped user manual and returns relevant sections with their page and heading. Use it for questions about Elowen's features, settings or where to find something. It searches the product manual, not your own code; use the code search tools for that.

When an embedding model is configured in Settings → Memory, search ranks sections by meaning. Otherwise, it uses keyword matching and says so in its results. It returns six sections by default; the k result limit can be set from 1 to 20. Each result includes the page, heading, text and a score. Results are ranked without a minimum-score cutoff; scores are relative to the current search, not a confidence rating. If keyword search finds no matching section, it reports that rather than failing.

The manual is read-only and updates when Elowen is upgraded. The index is built on first use and rebuilt when the manual or embedding model changes, so the first search after an upgrade may take a few seconds. Search results are grouped by heading, and sections longer than about 1,500 characters are split at paragraph breaks. The plugin has no settings.

Administrators manage the plugin in Settings → Plugins; select it to open its detail view. Only an administrator can enable or disable it, and it does not need an individual user grant. Enabling or disabling it takes effect after Elowen restarts.

For installing plugins and managing their permissions, see Plugins.