In-App Documentation

This functionality allows you to associate contextual help documents with assistants in workspaces. When configured, the web client will render a Markdown-based help file in the assistant, providing users with relevant guidance directly within the UI.

Installation and Configuration

1. Create the help document.

   • Write your help content in a Markdown (.md) file.
   • Save the file in the HelpDocuments container.
   • The filename must match the identifier used in the configuration, and must be lowercase (for example, jobhomehelp.md).

2. Declare the help document in the assistant.

   • In the workspace JSON, locate or create the assistant declaration.

   • Add the help attribute with the document name (without .md extension):

     {
       "assistant": {
         "help": "jobhomehelp"
       }
     }
     

   • This can be done per workspace or per tab, depending on where the assistant is defined.

3. Company and locale variants (optional)

   • You can provide company- and locale-specific versions by naming the file accordingly:

     jobhomehelp_2_en-us.md
     

Usage Notes

Multiple Assistants : If an assistant already exists (for example, RegistrationsAssistant), the help attribute must be added inside the assistant’s definition, not as a separate assistant object.

Conditional Assistants : If an assistant is conditionally rendered, and you want the help document to always be visible, duplicate the help attribute in an unconditional assistant block.

Case Sensitivity : Ensure the document name in the help attribute is lowercase to match the case-sensitive lookup in the database.

Troubleshooting

• Help Document Not Rendering?
  • Confirm the .md file exists in the HelpDocuments container.
  • Ensure the filename is lowercase and matches the help attribute.
  • Verify the assistant is correctly declared and rendered in the workspace.