Adding and editing documents

Upload text and Markdown files, write a document by hand, edit it and delete it.

For: Owners and editors of a knowledge base, and administrators · Last updated

The Documents list on a knowledge base page shows every document, with its Filename, when it was Uploaded, and its Status.

Status Meaning
Available The document is indexed and Coworkers can use it
Indexing… The document is still being processed
Failed The document could not be indexed

When a knowledge base has no documents, the list says none have been uploaded. The upload controls are in the Add a document card above it.

Who can change documents#

Everyone who can see a knowledge base can open its documents and read them. You can add, edit and delete documents if you are the knowledge base's owner, one of its editors, or an administrator. Other people see the documents read-only, with no Add a document card, no Save and no Delete.

Add a document#

The Add a document card gives you two ways.

Upload a file#

  1. In Upload a document, drag a file onto the box, or select browse and choose one.
  2. The box reads Uploading… while the file is processed.

Only .txt and .md files are accepted. A file in another format is rejected with a message that names the file. When the upload finishes, a message above the list reads "Uploaded" followed by the file name and how many chunks were indexed.

Create a document manually#

  1. Select Create document manually.
  2. Enter a name in the filename.md field. If you leave it blank the document is named untitled.md.
  3. Paste or write the text in the large field. The button stays unavailable until there is some content.
  4. Select Create document, or Cancel.

A message reads "Created" followed by the file name and the chunk count.

Read and edit a document#

  1. Select a document's file name in the list. Its text opens in an editor below the row.
  2. Change the text.
  3. Select Save. A message reports how many parts were re-indexed and how many were reused, and the editor closes. Only the changed parts of the document are processed again.
  4. Select Cancel to close without saving.

For a document that was collected from a web page, View source ↗ opens the original page.

Delete a document#

  1. Select Delete on the document's row.
  2. In the confirmation, select Delete document. The dialog states that the document's indexed content is removed too, and that this cannot be undone.

Where documents appear#

Coworkers cite documents in their replies. In a chat, you can open a cited document in the context pane.