Two tools, two jobs
Yaplet gives you two ways to publish content your customers and team can read:
- Knowledge base — rich-text help articles written for end-users. Visitors reach them from the Browse tab inside your widget and from a public help-center URL. Vex AI learns from every published article automatically.
- Documentation — long-form, markdown-based pages aimed at developers or power users. Published to a separate public portal. Not surfaced in the widget Browse tab.
If you are wondering which to open first, the answer for most teams is: start with the knowledge base. You can add documentation later when you have technical content that needs structured, code-heavy formatting.
Use the knowledge base when…
- Your audience is an end-user — someone who bought your product and needs help using it.
- You want the article accessible inside the chat widget (Browse tab).
- The content is conversational: "How do I reset my password?", "What does X button do?"
- You want Vex AI to cite your article when answering visitor questions automatically.
- Articles are short to medium length with images, bullet points, and step-by-step instructions.
Use documentation when…
- Your audience is a developer or system administrator.
- The content is structured and technical: API references, SDK guides, configuration manuals.
- You need code blocks with syntax highlighting labels (` ```javascript `), MDC components like callouts and steps, or deeply nested page hierarchies.
- You are fine with a separate public portal — documentation does not appear in the widget Browse tab.
Key differences at a glance
| Feature | Knowledge base | Documentation |
|---|---|---|
| Editor | Rich-text (Tiptap / HTML) | Markdown with MDC components |
| Primary audience | End-users | Developers / technical users |
| Widget Browse tab | Yes | No |
| Vex AI knowledge source | Yes — automatic | Yes — when pages are published |
| Public portal | Yes | Yes (separate URL) |
| Multi-language | Yes — per-article translations | Per-documentation language setting |
Can I use both?
Yes — and many teams do. A common setup is a knowledge base for customer support articles and documentation for an API reference or integration guide. The two products are independent; you can link between them in your articles using regular external URLs.
To get started, pick the one that matches your first piece of content. If you need help articles for your end-users, create your first knowledge base article. If you are building a developer reference, set up your documentation site.