Documentation

The documentation is short because the product is. Most stores need three things from it: to put the assistant on their site, to connect their catalogue, and to understand what the assistant did when an answer was not what they expected. Everything here is written for the person who will do those three things, whether that is the store owner, a developer or an agency.

Written

Four documents, each one read through before it went up.

  • Quickstart

    Put it on your store this afternoon: the script tag, the origin allowlist, the exact CSP directives, and what to check when nothing appears.

  • WooCommerce

    Live price and stock, options and variations, the cart handover, and two quirks of the Store API that will bite you.

  • Reading a trace

    What each part of the trace behind a recommendation means, and which symptom points at which stage.

  • Glossary

    Retrieval, chunking, embedding, thresholds, deflection, resolution, defined plainly, with what to ask a vendor.

Start with the quickstart

The quickstart takes an afternoon at most and ends with a shopper's question answered from your own catalogue. It covers the one script tag, the list of websites your assistant is allowed to answer on, the exact Content Security Policy lines a strict site needs, and what to check when the chat button does not appear. If you use WooCommerce, the plugin does the script tag and the catalogue for you, and the quickstart points you to it.

Then read a trace

The most useful twenty minutes you can spend after installing is reading the trace behind ten real answers. It shows which passages the assistant considered, what each scored and which it refused to use, and it is how almost every wrong answer is diagnosed. The guide explains each part of the panel and which symptom points to which fix.

What is covered

  • Installing. The script tag, allowed websites and the WooCommerce plugin.

Coming next

  • Knowledge. Crawling your site, uploading files, syncing your catalogue and keeping it fresh.
  • Answers. Verified answers, rules and tone, languages, and the review queue.
  • Selling. Product cards, the cart in the chat, checkout, and the sign-up, log-in and plan buttons.
  • Your team. Handover, the inbox, roles and notifications.
  • Integrating. Webhooks and their signatures, and custom tools.

Not written yet

Listed so you know what to ask for. Missing something else? Tell us what you were looking for: it is the fastest way to get it written.

  • API reference

    Specified as generated from an OpenAPI document. That document does not exist yet, and a hand-written reference drifts from the API within weeks, so we would rather have nothing here than something misleading.

  • Self-hosting

    Not documented, because it is not supported.

  • Migration guides

    Not written. If you are moving from a specific platform, ask and we will tell you what does and does not carry over.

When the documentation is not enough

Every conversation in your console has a link. Send it to support with what you expected the assistant to say. The link carries the trace, which usually answers the question before we need to ask one.

Keeping the documents right

Each document says when it was last checked against the product, and it is corrected as soon as a change makes it wrong.

For developers

The widget is one script tag and no build step. Everything a developer needs, from the allowed-website list to webhook signatures, is in the console.

Start with the quickstart

One script tag, the origin allowlist, the CSP directives, and a shopper's question answered from your catalogue by the end.