Add Quill getting started section - #2606
Conversation
reebhub
changed the title
getting started section
8b948fa to
c81df4e
Compare
e4c4297 to
484a7f0
Compare
…cs links - climb the tree and add the .mdx suffix
…interlink Quill pages
There was a problem hiding this comment.
Pull request overview
This pull request adds a new Quill “Getting Started” documentation section and wires it into the existing Quill overview so readers can follow a guided, step-by-step onboarding path.
Changes:
- Added a complete Getting Started path (overview + six steps) under
quill/getting-started/. - Updated
quill/overview.mdxto link into the new Getting Started content and improve cross-references to related Quill docs. - Added/expanded deep links from the overview into specific setup and security topics.
Reviewed changes
Copilot reviewed 8 out of 101 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| quill/overview.mdx | Updates overview text and replaces several references with direct links into the new Getting Started section and related security/developer pages. |
| quill/getting-started/overview.mdx | Introduces the six-step Getting Started roadmap plus prerequisites. |
| quill/getting-started/signing-up.mdx | Documents the sign-up flow and how users obtain keys/command. |
| quill/getting-started/starting-quill.mdx | Documents running Quill via Docker and signing into the dashboard. |
| quill/getting-started/connecting-your-database.mdx | Covers database prerequisites and the dashboard wizard for connecting and verifying schema readiness. |
| quill/getting-started/mapping-your-tables.mdx | Explains mapping options, editing the mapping, testing, and app creation/ingest. |
| quill/getting-started/adding-an-ai-agent.mdx | Covers LLM connection, agent drafting, review/edit, testing, and saving. |
| quill/getting-started/adding-a-chat-widget.mdx | Covers creating a web widget channel, generating embed links, and embedding the widget on a site. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| the widget: | ||
|
|
||
| ```html | ||
| <iframe src="https://public.<your-domain>/apps/<app-slug>/embed/<link-token>" width="400" height="600"></iframe> |
There was a problem hiding this comment.
--> Set the width and height to suit your layout, and shape the element as you please: a title attribute, a style, or any other addition that blends the widget into your site.
note that the snippet itself is a precise copy of the Embed snippet generated by Quill. changing the page so the snippet would include a title will confuse readers who try it out, since this is not what they get. if the snippet changes on the product side, we'll reflect its new form here.
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| The command's parts: |
There was a problem hiding this comment.
-->The Docker command carries your license key and your dashboard API key: share it with no one.
For example, pasting the command into a support ticket or a chat exposes both keys.
|
|
||
| Keeping Quill secure is part of the package: at sign-up, Quill receives its own web address and TLS certificates, | ||
| so its management dashboard and the [chat widget](overview.mdx#chat-widget) it runs are served over HTTPS from the | ||
| Keeping Quill secure is part of the package: at sign-up, Quill receives its own web address and |
There was a problem hiding this comment.
Just noticed that these section are not listed on the right. Is it intentional?
There was a problem hiding this comment.
@Lwiel markdown titles (###xxx) show up, but the panels themselves (<Panel heading="yyy">) don't
There was a problem hiding this comment.
@reebhub @Lwiel @poissoncorp
There is an open ticket for this from quite a while ago:
https://issues.hibernatingrhinos.com/issue/RDoc-3631/Panel-headings-are-missing-from-TOC
| *The agent goes live.* | ||
| You create a **channel** that carries the conversations between your users and the agent: a [chat widget](getting-started/adding-a-chat-widget.mdx) | ||
| on your site, a Telegram bot, a Slack app, or a Discord bot. | ||
| For a chat widget, for example, you generate an **embed link** through the channel; placed in a page of |
There was a problem hiding this comment.
When I read it I get a bit confused what widget is and and what channel is. I'd propose something like
| For a chat widget, for example, you generate an **embed link** through the channel; placed in a page of | |
| For a chat widget channel type, for example, you generate an **embed link**; placed in a page of |
There was a problem hiding this comment.
-->
For a chat widget channel, for example, you generate an embed link; placed in a page of your site, the link will display the widget, live and answering from the mirrored data.
| <Admonition type="note" title=""> | ||
|
|
||
| * Quill adds AI capabilities to your existing SQL database (PostgreSQL, SQL Server, or MySQL). | ||
| The **Getting Started** section takes you, in six steps, from signing up for Quill to a **chat widget** |
There was a problem hiding this comment.
The first and the next sentence are about something totally different. It feels detached. Is it intentional?
There was a problem hiding this comment.
it's a general orientation sentence to remind you what you're doing here, but if it disorients you instead it doesn't do a very good job at it. removed, will leave the orientation for the general overview.
| * Quill adds AI capabilities to your existing SQL database (PostgreSQL, SQL Server, or MySQL). | ||
| The **Getting Started** section takes you, in six steps, from signing up for Quill to a **chat widget** | ||
| on your site, where your users ask and your AI agent answers from Quill's live copy of your SQL data. | ||
| This page presents [the six steps](#the-six-steps) and [the things to prepare](#prerequisites) before you start. |
There was a problem hiding this comment.
I'd ditch the number from the header, the link and the messaging. Mentioning numbers later gets convoluted if you want to change the number. Also, breaking links.
A soft suggestion
| This page presents [the six steps](#the-six-steps) and [the things to prepare](#prerequisites) before you start. | |
| This page presents [all the steps](#the-six-steps) and [the things to prepare](#prerequisites) before you start. |
| data, the agent, and the agent's queries, and you approve or adjust each draft. | ||
|
|
||
| * The chat widget is one of several channel types Quill offers, all carrying conversations between your | ||
| users and an agent: once the widget runs, a Telegram bot, a Slack app, or a Discord bot can follow. |
There was a problem hiding this comment.
once the widget runs, a Telegram bot, a Slack app, or a Discord bot can follow.
What does it mean? Is the chat widget a prerequisite for the others? I think we should use channel more through the documentation.
There was a problem hiding this comment.
-->
The chat widget is one of several channel types Quill offers, all carrying conversations between your users and an agent. You can also add a Telegram bot, a Slack app, or a Discord bot.
| Before adding an agent, make sure you have the access details for an | ||
| [LLM provider](../overview.mdx#llm), which your agent will use to phrase its replies: | ||
|
|
||
| * Quill works with three chat-model providers: **OpenAI** and **Azure OpenAI**, hosted services you hold an |
There was a problem hiding this comment.
Three? What if one is compatible with others? I'd omit the number
|
|
||
| * Quill works with three chat-model providers: **OpenAI** and **Azure OpenAI**, hosted services you hold an | ||
| API key for, and **Ollama**, running locally on your own machine. | ||
| A local model keeps your conversations off a third party's servers, at the cost of quality: answers can fall |
There was a problem hiding this comment.
privacy, a word worth to mention
The quality is hosting dependent and I'd omit the mention of quality altogether.
| The **Add agent** wizard can be started in two ways: | ||
|
|
||
| * If you arrived here from the previous Getting Started step, you are already in the right place: you followed | ||
| the **Add new app** wizard, clicked **[Continue](../getting-started/mapping-your-tables.mdx#creating-the-app)** at its last |
There was a problem hiding this comment.
Why link back with Continue here?
| 3. **WhatsApp Personal** and **WhatsApp Business** | ||
| Marked **Coming soon**, and cannot be selected yet. | ||
|
|
||
| 4. **Slack** and **Discord** |
There was a problem hiding this comment.
This is the first page that mentions these I think. If this is the case, should it be mentioned at the top overview as well? Or soften the listing elsewhere so that it provides some examples and many more.
| Every parameter the agent declares has to be given a value before the link can be generated. | ||
|
|
||
| The values you enter for these parameters are bound into the link and cannot be changed by users. | ||
| You can, for example, generate an embed link for a specific customer, with the customer's ID already bound |
There was a problem hiding this comment.
The image above discusses the productID, while the text mentions a customerID. I'd make them coherent.
Issue link
RDoc-4045 signing up
RDoc-4046 starting Quill
RDoc-4047 connecting your database
RDoc-4068 mapping your tables
RDoc-4048 adding an AI agent
RDoc-4049 adding a chat widget
RDoc-4079 getting-started overview
Additional description
articles for Quill's getting-started section
Type of change
/templatesor readme)Changes in docs URLs
/scripts/redirects.jsonfile, setDocuments MovedPR label)Changes in UX/UI