Documentation | Yaplet

Overview

The Documentation feature lets you build complete technical documentation sites — API references, developer guides, product manuals — and publish them as branded public pages through your widgets. Content is organized in a three-tier hierarchy: documentations contain categories, which contain pages with nested sub-pages.

Hierarchical Structure — Organize content into documentations, categories, and nested pages for clear navigation.

Markdown Editor — Write with a split-pane interface featuring a tree view for navigation and a rich markdown editor with components.

AI Assistance — Generate, continue, or improve documentation content with built-in AI tools.

Public Sharing — Publish documentation through connected widgets with branded public pages.

How It Works

From the Documentation page, you'll see a table listing all your documentations with their title, page count, and language. Click New Documentation to create one, then add categories and pages inside it.

Create a Documentation

Click "New Documentation" to create a new documentation container. Configure its title, language, and branding in the settings.

Add Categories

Inside a documentation, create categories to group related pages. Categories appear as navigation tabs on the public page.

Write Pages

Select a category to open the split-pane editor. Use the tree view to manage your page hierarchy and the markdown editor to write content.

Connect a Widget

Attach your documentation to one or more widgets in the widget settings. This enables public access through the widget's branded URL.

Publish

Toggle categories and pages to "Published" to make them publicly accessible and available in AI knowledge.

Connect your documentation to widgets to enable public sharing. Each widget provides a different public URL and visual theme for your documentation.

Guides

Docs and Categories

Learn about the hierarchical structure of documentations, categories, and pages, including configuration options, publishing controls, and widget connections.

Building Docs

Explore the split-pane editor interface for creating and organizing documentation content with advanced markdown editing and AI assistance tools.

Sharing

Understand how to generate public links for your documentation pages, including direct (SEO-friendly) and fixed (permanent) link types.

Documentation vs Knowledge Base

Yaplet offers two distinct content creation features — Documentation and Knowledge Base — that serve different purposes and audiences. Understanding their differences helps you choose the right tool for your content strategy.

Documentation

Purpose: Technical documentation with structured, developer-focused content

Content Style: Rigid, formatted technical details using markdown components

Editor: Markdown Article Editor with premade components and AI assistance

Access Channels: Only available through dedicated public pages

Best For: API references, technical specs, developer guides, structured manuals

Knowledge Base (Help Center)

Purpose: Customer-facing help articles with conversational, accessible content

Content Style: Text and sentence-based help using flexible HTML editing

Editor: HTML Article Editor for rich text formatting

Access Channels: Available in chat widgets AND dedicated public pages

Best For: Customer support, FAQs, troubleshooting guides, product tutorials

When to Use Documentation

Choose Documentation when your audience is technical users who need detailed, structured information about APIs, configurations, or technical implementations.

API documentation: Technical specifications, endpoints, and code examples
Developer guides: Integration instructions, SDK documentation, technical workflows
System configurations: Detailed setup and configuration procedures
Technical specifications: Rigid, component-based content requiring precise formatting

When to Use Knowledge Base

Choose the Knowledge Base when your primary audience is end-users who need quick answers to common questions and practical guidance.

Customer support scenarios: "How do I reset my password?" or "How do I upgrade my plan?"
Product tutorials: Step-by-step guides for using your product features
Troubleshooting articles: Common issues and solutions in conversational language
FAQ-style content: When you want content accessible directly in chat conversations

Key Decision Factors

Documentation: Developers, technical teams, system administrators
Knowledge Base: General customers, end-users, non-technical audience

Pro Tip: Many organizations use both features together — Documentation for technical resources and Knowledge Base for customer support. You can link between them to create a comprehensive content ecosystem.

Learn more about the Knowledge Base feature to understand when it might be the better choice for your customer-facing content needs.