Skip to content

RDoc-4102 - add a web widget channel page to Quill's channels section - #2678

Open
reebhub wants to merge 2 commits into
ravendb:mainfrom
reebhub:RDoc-4102_webWidget
Open

reebhub wants to merge 2 commits into
ravendb:mainfrom
reebhub:RDoc-4102_webWidget

Conversation

@reebhub

@reebhub reebhub commented Sep 22, 2026

Copy link
Copy Markdown
Contributor

Issue link

RDoc-4102 add a web widget channel page
RDoc-4112 rename channel and interface names

Type of change

  • Content - docs
  • Content - cloud
  • Content - Quill
  • Content - guides
  • Content - start pages/other
  • New docs feature (consider updating /templates or readme)
  • Bug fix
  • Optimization
  • Other

Changes in docs URLs

  • No changes in docs URLs
  • Articles are restructured, URLs will change, mapping is required (update /scripts/redirects.json file, set Documents Moved PR label)

Changes in UX/UI

  • No changes in UX/UI
  • Changes in UX/UI (include screenshots and description)

Comment thread quill/channels/overview.mdx Outdated
* A **channel** carries the conversations between your users and an [agent](../overview.mdx#ai-agent)
of your app: user messages reach the agent through the channel, and replies return the same way.
Quill offers four channel types: a chat widget on your site, or a bot on Telegram, Slack, or Discord, reaching your users where
Quill offers four channel types: a web widget channel with a chat box on your website, or a bot on Telegram, Slack, or Discord, reaching your users where

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can also be embeded in other places, e.g. an app

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/channels/overview:
"Quill offers four channel types: a web widget channel with a chat box embedded in your website or app"

/channels/web-widget (an additional bullet):
"The chat box can also be embedded in a phone app, in a component that displays web pages as a browser does.
This article follows the website case."

when the embed tab changes are applied I'll updated the Embed tab section with its capture and a few words about the app options.

Comment on lines +143 to +148
A different section is shown here for each channel type:
- For the web widget channel depicted here: the websites allowed to embed the chat box
(see [Editing the channel name and allowed origins](../../channels/web-widget.mdx#editing-the-channel-name-and-allowed-origins)).
- for a Telegram bot: the option to replace the bot token (see [Channels: Telegram bot](../../channels/telegram-bot.mdx#rotating-the-bot-token)).
- for a Slack bot: the option to rotate the credentials (see [Channels: Slack bot](../../channels/slack-bot.mdx#rotating-the-credentials)).
- for a Discord bot: the option to replace the bot token (see [Channels: Discord bot](../../channels/discord-bot.mdx#rotating-the-bot-token)).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The last three points aren't related to allowed origins at all

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clarified (it's a general channels-view page, so it has to explain that this section changes for each channel type)

-->
The websites allowed to embed the chat box (see Editing the channel name and allowed origins).

This area of the form holds a different section for each channel type:
- For a Web widget: the allowed origins, as depicted above.
- For a Telegram bot: the option to replace the bot token.
- For a Slack bot: the option to rotate the credentials.
- For a Discord bot: the option to replace the bot token.

Comment thread quill/channels/web-widget.mdx Outdated

A web widget channel is added using Quill's management dashboard, in a short form that asks you to:
* Select the agent that will answer the chat box's users.
* Give the channel a name (optional).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not optional now - ravendb/ravendb#23679

@reebhub reebhub Sep 23, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

text updated, captures will have to wait for a working version that includes the change.

Comment thread quill/channels/web-widget.mdx Outdated
and further messaging will be disabled.
A new conversation requires a new embed link.

![Chat boxes, their conversations, and the agent](./assets/web-widget_conversations.svg)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Usually it's the same page, just accessed by different users

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added a "Two ways to generate the link" section with the two options explained and a diagram for each.

Comment thread quill/channels/web-widget.mdx Outdated

#### The link is unknown:

The channel was deleted, or the link expired long ago and Quill has removed its record.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should be precise with expiration time here

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-->
The channel was deleted, or the link expired and its record was already removed.
Quill removes an expired link's record about a minute after it expires.

And in "The link has expired or was revoked, or the channel is paused":
-->
An expired link shows this notice for about a minute, until Quill removes its record.

Comment thread quill/channels/web-widget.mdx Outdated

- When the agent receives a chat box user's question over the channel, the agent forwards the question to the LLM.
- While composing an answer, the LLM may send the agent a query request, naming the query tool to use.
The agent will find the requested tool in its configuration, fetch the [RQL](/7.2/querying/rql/what-is-rql) query

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use an absolute, versionless URL here

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment thread quill/channels/web-widget.mdx Outdated
Strings and numbers are entered in a text field.
Booleans are set using a toggle.
Arrays are entered one value at a time using the **Add value** button.
A **Null** parameter requires no value.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't mention null parameter here, it's a bug that it's visible on the list

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants