Setting up the AI assistant chat
The AI assistant is a chat window on your help centre where readers ask questions in their own words and get instant answers from your published docs. Each answer links to the docs it used, so readers can read more.
📷 Image placeholder: the AI assistant chat answering a question with links to source docs.
Turn on the assistant
Open the AI settings
Go to PinkDocs → Settings and open the AI tab.
Enable the chat
Turn on AI assistant.
📷 Image placeholder: the AI assistant toggle in PinkDocs settings.
Choose where it appears
Choose whether the chat appears on every docs page or only on the docs homepage.
Save
Click Save Changes, then open your help centre to see the chat button.
Customise the assistant
| Setting | What it does | Example |
|---|---|---|
| Assistant name | The name shown at the top of the chat | PinkDocs Helper |
| Greeting | The first message readers see | Hi! Ask me anything about PinkDocs. |
| Suggested questions | Example questions readers can click | How do I change my docs URL? |
| Fallback message | What the assistant says when it can't find an answer | I couldn't find that in our docs. Contact support. |
| Knowledge bases | Which knowledge bases the assistant answers from | Main |
Write a friendly greeting
Tell readers what the assistant can help with in one sentence.
Add suggested questions
Add three to five common questions. Take them from your popular searches.
Set a helpful fallback
Include a link to your support page so readers always have a next step.
📷 Image placeholder: the assistant customisation settings filled in.
Test the assistant
Ask a question you know the answer to
Open your help centre and ask a question covered by a doc. Check the answer is correct and links to the right doc.
Ask a question you haven't documented
Check the assistant shows your fallback message instead of guessing.
Check the AI report
Go to PinkDocs → Analytics → AI to see your test questions recorded.
Common questions
The assistant answers from your published docs. When it can't find an answer, it shows your fallback message.
Yes. The assistant only answers from docs the current reader is allowed to see, so restricted docs stay private.
