Skip to content
AssemblyAI Logo AssemblyAI Playbooks
GitHub

How to add or update an entry to the Pylon Knowledge Base (FAQ)

Introduction - What is the AssemblyAI FAQ

Our External AssemblyAI FAQ in Pylon is intended to be a living document that is continually being added to and updated. This guide will walk you through the process of updating an entry and adding a new entry to the FAQ.

Procedures

To access the External FAQ, click the Knowledge Base on the left menu of the Pylon homepage.

Adding a new Collection

  1. From the Knowledge Base page, click Collections on the left menu. Click the “Create Collection” button on the top right of the page.

  2. You can add the Collection Name, which would be the group name (e.g. General, Security etc), icon, and the text content.

  3. Click “Create” to submit the collection.

Adding a new Article

  1. From the Knowledge Base page, click Articles on the left menu. Click the “Create Article” button on the top right of the page.

  2. Select “Article”.

  3. You can add the title which would be the question and specify the Collection it belongs to (e.g. General, Security, API Information etc.)

  4. You are then directed to the editor where you can add text content, which would be the answer to the question.

  5. Click the settings button to set the Visibility to Public.

  6. On the top right of the page, you can publish the article when complete. It’s also automatically saved as a Draft for you to return to without publishing.

Note: If you would like the article to only be visible to AssemblyAI employees, select Visibility to Internal.

Re-arranging How Articles and Collections are Displayed

  1. You can rearrange the order of Collections and Articles. Click Collections on the left menu. Click the “Reorder” button on the top right of the page. Drag and drop articles to the position you want.

  2. This can be done with articles in the Collection as well.

How to Edit Articles

  1. You can click on any article to make edits at any time.

  2. Click the settings button to save the changes made

#Appendices

Article: In the context of the Internal FAQ, each article refers to the singular Frequently Asked Question and its corresponding answer.

Collection: To organize the articles, each article will belong to a relevant collection in the Pylon Knowledge Base. For example, an article that references the Playground will be published under the “Playground” collection.

Knowledge Base: Pylon’s terminology for the Collections and Articles list created in the app.