Customize how Knowledge Assistant answers in Knowledge Assistant in the
dashboard. Customize its appearance in dashboard Settings or docs.json.
Assistant behavior
On the Pro plan, open Knowledge Assistant → Behavior to tailor the assistant for each site:
| Setting | What it controls | Default |
|---|---|---|
| Business or product name | The business or product the assistant represents | Your docs title |
| Role and audience | Who the assistant helps and how it should frame its help | General product support |
| Default tone | Conversational, professional, or formal wording | Conversational |
| Default answer detail | Concise answers, detail that adapts to the question, or fuller explanations | Concise |
| Additional instructions | Writing preferences, terminology, and support guidance in Markdown | None |
Role and audience starts with the actual default text, ready to edit. Keeping that text unchanged uses the default; saving custom wording overrides it.
Business or product name initially shows your docs title. Saving that name unchanged continues to follow your docs title; saving a custom name overrides it for the assistant’s answers. Clearing the name restores the docs title when you save. Before the first docs ingestion, the field is blank unless customized. It does not change your docs title, assistant panel header, or MCP tool labels.
For example, set the role and audience to “Help small business owners set up and use our booking software. Assume they are new to the product.” Additional instructions might look like:
Additional instructions can refine the tone and detail defaults. The assistant still grounds product claims in your sources, cites supporting information, and explains specific gaps when information is missing. Put product facts and policies in Additional sources. Support links in instructions can guide readers to help; they are not evidence for product claims.
Select Save changes to apply all settings. They apply to the next question, including in existing conversations, on both your docs site and external embeds. No docs rebuild is required. Reset discards unsaved edits and restores your last saved settings.
Custom business or product names are limited to 200 characters; role and audience to 1,000 characters; additional instructions to 8,000 characters. These settings do not rename the assistant panel or change which content is searched.
Assistant appearance
Use dashboard Settings for no-code appearance controls, or configure the
following settings in docs.json:
| Setting | What it controls |
|---|---|
| Button | The floating assistant launcher button |
| Navbar button | An optional assistant entry in the top navigation |
| Heading | The heading shown inside the assistant panel |
| Suggested questions | Up to three starting prompts shown before a conversation begins |
| Icon | A local image used for the assistant icon |
Configure in docs.json
Add an assistant object to docs.json:
Suggested questions
Suggested questions should sound like real reader questions. They work best when they point to high-value workflows or common moments of uncertainty.
Use questions like:
- How do I publish a dashboard edit?
- How do I add a page to navigation?
- How do I configure Knowledge Assistant?
Avoid vague prompts like:
- Tell me about the docs.
- What can you do?
- Read more.
Assistant icon
Assistant icons must be local image files in your docs root. Use a path such as
/favicon.svg or /images/assistant.png.
Do not use an Iconify name or a remote URL for the assistant icon.
Button and color behavior
The assistant button uses your docs theme by default. Set a button color when the assistant needs to stand out from the rest of the page or match a specific brand treatment.
button.size can be default or small.