InkBotDocs

Quill

Connect Quill docs sites so bots can find, write and tidy your documentation, each bot with its own key.

Quill is a documentation site you host yourself. Connected to InkBot, the bots you choose can search and read its pages, write new ones (as drafts for you to review), add to and tidy existing ones, arrange the sidebar and upload pictures. Deleting a page always asks you.

Connect a site

  1. Add it

    Settings → Plugins → Add plugin → Quill. Enter the site's address and, optionally, a name for it in InkBot.

  2. Approve the code

    Your browser opens Quill's admin pages, showing a code. Check it matches the one in InkBot and approve it (sign in as an admin if asked). There are no keys to copy.

  3. Choose the bots

    Switch on the bots that should work on its docs. Each one gets its own key on the site, named "InkBot: bot name", so the site shows who changed what. Switching a bot off revokes its key.

The connection appears on the site under Connected apps, where you can also revoke it. Disconnect in InkBot revokes InkBot's connection and every bot's key. Pages the bots wrote stay.

Several sites

Connect as many Quill sites as you use with Connect another Quill site…. Each site has:

  • a Name you choose, so you can tell them apart (empty means the site's own name), and
  • What's on it, a sentence that tells bots what the site is for, e.g. "Public product docs for customers".

A bot on one site gets a quill tool. A bot on several gets one tool per site, named after it (for example quill_product_docs and quill_internal_wiki), along with what each is for. When it's unclear which site you mean, it asks.

What bots can do

Action
pages, search, read Find and read pages (drafts included)
create A new page, as a draft unless you asked to publish
update, append Rewrite a page, or add to its end
move A new address or place in the sidebar
delete Always asks you first
navigation, set_navigation Read or rearrange the sidebar
upload A file from the workspace, such as a screenshot
preview Render Markdown without saving

Page cards and drafts

Pages a bot made or changed show as cards in the chat, with the title, draft or published, and who changed it last. A draft's card opens its preview link, which works without signing in, so you can share it for review before publishing.