Before you start
Before you start creating categories and articles for your Knowledge Base (KB), you need to configure the Documentation settings.
To begin, enter the settings panel. Go to Settings > App Settings in the main menu on top then choose the Additional > Knowledge base settings option.
Here we are!
- Start by setting your domain and subdomain. To find out more about that, read the article here.
- Once you have done the first step, choose the best background and logo to customize your docs page. The logo has a CSS max-width set at 165 px. If you want to have the 512x512 logo or another on the page, you can set it by yourself in the CSS section (see "point 4"). The same applies to the background: when it comes to styles, we can define them ourselves. On the picture below, you can see how the images appear on a real knowledge base page. Remember that you can hide one of the pictures if you don’t want it to be visible directly from the settings page.
- Redirect url: is the link that can help your user to get back to your website in one click. It appears on the top right side of the Knowledge Base page.
- Custom CSS can be set according to your needs. It’s not an obligatory. There, you can put the code that will change the font or color on the documentation page.
- When the user opens your docs, the tab should have a name in the user’s browser. You decide what the user should see there. It is called title.
- The text that will be placed on top of the KB page is called description.
- You can also customize the grey text that is shown in the search bar, e.g. “Type your question…” or “Find the answer…”. It is called search placeholder.
- Categories description is the description placed under Categories: a subtitle, if you will, for your documentation.
Now, after you connect your page with the documentation and set the design, you can create your content and fill out the page with categories and articles.
To find out more about articles creation, follow the instructions in this article.