Knowledge base site overview

Knowledge base site introduces an improved experience for accessing articles and browsing information. With an enhanced user interface, better search functionality using AI, and streamlined content organization, users can quickly find relevant articles and troubleshoot issues efficiently. New features such as real-time updates and interactive elements make it easier to navigate and engage with content. The Knowledge base site ensures a more intuitive and efficient knowledge-sharing experience for all users.

Key features of the knowledge base site

The knowledge base site includes a range of features designed to improve content accessibility, personalization, and reader engagement.

Overview of the documentation page

The following image illustrates the Header section (1), Left navigation pane (2), Article section (3), and Right-side pane (4) in the documentation page of the Knowledge base site.

1. Logo image: Displays your organization’s branding element/logo. Clicking on it navigates you to your documentation home page.

2. Workspace:

   Use the dropdown to navigate through the different workspaces available in the Knowledge base.

   Click on the API documentation workspace to navigate to the API documentation home page.

3. Primary navigation: Customize the primary navigation to help you navigate to different pages from your home page or Knowledge base site.

4. Notifications () icon: The “What's New” page displays recently published articles (new and updated) in the selected workspace and notifications for exported PDF files that are ready for download.   A badge displays the unread count, which clears when you view the relevant notifications. The bell icon appears after the first PDF export is initiated and remains available even when the Read receipt is disabled.

5. Acknowledgment required (): This page displays the list of acknowledgment required/acknowledged articles.

6. Theme: Switch between System theme, light, and dark themes in the Knowledge base site.
   By default, the light theme will be set as the system theme.

7. Language: Select the desired language from the available list to read the articles.

   NOTE

   If only one language is configured for a workspace, the language dropdown will not appear in the Knowledge base site.  

8. Secondary navigation: Customize the secondary navigation to help you navigate to different pages from your home page or knowledge base site.

2. Left navigation pane

3. Article section

1. Breadcrumbs: Navigate back to the category and sub-category of the article.

2. Article title: Displays the title of the article.

3. Copy link: Click to copy the article’s URL to the clipboard.

4. Status badge: Displays the status of the articles (new, updated, custom).

5. Article date: View the published or updated date of the article.

6. Read time: View the estimated average time it would take to read the article based on word count.

7. Contributors: View the list of contributors who have worked on this article.

8. Follow: Click here to follow the articles. This feature is available for reader accounts.

9. Favorites (❤️): Click the ❤️ icon in the article header to add or remove the article from your favorites for quick access. This is available to logged-in users in private projects.

10. Share icon: Share the article via Twitter, LinkedIn, Facebook, or Email.

11. Export PDF: Allows users to download the article or category as a PDF when enabled by the admin. Category-level PDF export is available for logged-in users only. The Export PDF icon appears in the article header and may be moved to the More (⋯) menu on smaller screens.

12. More options (): Click Print to print the article or export it as a PDF. The available options depend on your browser’s print settings.

13. Article summary: Click to view the summary of the article generated by Eddy AI.

4. Image

When you click an image on your Knowledge base site, it opens in an image viewer.

1. Title text: It displays the caption of the image, if any.

2. Open link: To open the image URL, if available.

3. Zoom out (): To zoom out or minimize the image.

4. Zoom in (): To zoom in or enlarge the image.

5. Download (): To download the image to your local storage.

6. Close (X): To close the image.

7. Next (): To move to the next image.

8. Previous (): To move to the previous image.

   Hold and drag the image to move it anywhere on the screen. The image closes when you click anywhere on the screen outside the image.

   

5. Right pane

By default, the right pane sections are displayed in the following order: Files → Tags → Related articles → In this article.

Admins can customize this order using drag-and-drop by going to Settings > Knowledge base site > Article settings & SEO. Under Article right section, click Reorder sections.

6. Article footer

1. Feedback on the Article: Click Yes or No and enter your feedback for the article.

2. Previous and Next Article: Navigate to the previous and next articles in the category.

3. Related articles: View articles related to the current article. By default, this section appears at the article footer. Admins can move it to the right-side panel by enabling the Show related articles toggle under Settings > Knowledge base site > Article settings & SEO > Article right. When moved to the right-side panel, it no longer appears in the article footer.

Sticky header on scroll

As readers scroll through a long article, the following header icons remain fixed and visible at all times:

• Theme switcher (Dark & light theme)

• Profile icon

• Language selector

• Search bar

• Share

• Edit (for users)

• Export PDF (if enabled by admin)

• Print (if enabled by admin)

• Follow

• Favorites (if enabled by admin)

On smaller screens, header actions collapse into a More (⋯) overflow menu. The sticky header does not overlap article content.

Localize or customize default UI text in the knowledge base site

You can localize or customize the default UI text displayed in the knowledge base site using the Localization variables feature. This allows you to translate system-generated labels into other languages or modify them in English.

To update the UI text:

1. Navigate to Settings () in the left navigation bar.

2. In the left navigation pane, navigate to Knowledge base portal > Workspace & localization.

3. In the Localization variables tab, expand the relevant category to view and edit available text fields.

4. Make your changes and click Save.

NOTE

By default, the system localizes variables to the respective language.

document.addEventListener("DOMContentLoaded", function () {
  document.addEventListener("contextmenu", function (e) {
    let el = e.target;
    while (el && el !== document) {
      if (el.tagName === "A") {
        e.preventDefault();
        break;
      }
      el = el.parentElement;
    }
  });
});