Knowledge Base

Your Knowledge Base is a public help center where customers can browse articles organized by categories, search for answers, and rate content — all styled to match your brand.

Overview

The Knowledge Base is a customer-facing help center hosted at {your-widget-id}.yaplet.help/k. It provides a branded, searchable library of articles organized into categories and sub-categories. Visitors can find answers on their own without contacting support.

Branded Design

Automatically styled with your widget's color scheme and logo.

Full-Text Search

Visitors can search across all article titles, descriptions, and content instantly.

Multi-Language

Serve articles in multiple languages with automatic language switching.

Article Ratings

Visitors can rate articles to help you identify what's helpful and what needs improvement.


How It Works

Your Knowledge Base is accessible at:

https://{widget-id}.yaplet.help/k

Replace {widget-id} with your widget's URL identifier, found in Widget Settings > General > Widget URL.

The Knowledge Base must be connected to a widget to be publicly accessible. Set this up in Widget Settings > General > Connections > Knowledge Base.

Page Structure

Home Page

The home page features a hero section with your logo, a welcome message ("How can we help?"), and a prominent search bar. Below, categories are displayed in a responsive grid of cards showing:

  • Category name
  • Number of articles or sub-categories
  • Short description

Category Page

Clicking a category shows its contents:

  • Sub-categories displayed as cards (if the category has nested categories)
  • Articles listed with document icons and titles
  • Breadcrumb navigation to easily navigate back

Categories can be nested, allowing you to organize content hierarchically (e.g., Getting Started > Account Setup).

Article Page

Each article displays:

  • Full breadcrumb trail
  • Article title and formatted content
  • Related articles from the same category
  • A rating widget where visitors can give feedback (positive, neutral, or negative)
  • An image viewer that opens a fullscreen carousel when visitors click on any image

The search bar appears in the header on every page. As visitors type, results appear in a dropdown showing:

  • Top Articles when the search bar is focused but empty — a quick-access list of popular articles
  • Search results grouped by match type (title, description, or content) with highlighted snippets

Search is debounced (500ms) so results update smoothly as visitors type.


Multi-Language Support

If your Knowledge Base has articles in multiple languages, a language switcher appears in the header. Visitors can switch languages, and the URL updates to reflect the selected language:

https://{widget-id}.yaplet.help/k/en    → English
https://{widget-id}.yaplet.help/k/es    → Spanish

The language is validated on page load — if a visitor lands on an unsupported language, they are redirected to the default.


Branding & Styling

The Knowledge Base automatically inherits your widget's color configuration. All colors — backgrounds, text, borders, buttons, and accents — are derived from the color scheme you set in Widget Settings > Appearance.

Your widget's logo is displayed in the header. If no logo is configured, your widget name appears as text instead.

Customizing your widget colors in the Appearance tab will instantly update your Knowledge Base's look and feel — no extra configuration needed.

Widget Integration

When the Knowledge Base is connected to your widget, it also enables:

  • In-widget article search — Visitors can browse and read articles directly inside the chat widget
  • AI training — All Knowledge Base content is automatically used to train your connected AI chatbot, enabling it to answer questions based on your articles

The Yaplet chat widget is also embedded on the Knowledge Base pages, so visitors can start a conversation at any time.


Article Ratings

Each article includes a rating section at the bottom with three options:

RatingIconPurpose
Positive😁The article was helpful
Neutral😐The article was okay
Negative😞The article didn't help

Visitors can rate once per visit. Use these ratings to identify articles that need improvement.