Overview

Documentation brings together Help Center articles and API documentation in one site. Publish customer help articles, developer guides, and an API reference generated from an OpenAPI spec.

Both parts share branding, navigation, and editing tools. Start with help articles and add API documentation when you need it.

Start with the content you need

Help Center

Write answers to common questions, setup guides, and troubleshooting steps. Group related articles into collections so customers can find the next step.

Start with Set up the Help Center. If you already have content elsewhere, import your articles.

API documentation

Import an OpenAPI spec to generate endpoint pages with request details, responses, code samples, and an API playground. Add written guides alongside the generated reference.

Start with the API documentation overview, then publish your first API reference.

Organize and publish your documentation

Use tabs and top-bar links to separate sections such as guides and API reference. Within a tab, use collections and articles to build the sidebar.

Open Help Center in the dashboard to manage your content. The editor saves article drafts as you write. Publish when the content is ready for customers. Managing articles & collections covers navigation, editing, publishing, and version history.

Use the block library to add callouts, FAQs, images, videos, tables, and code examples.

Match your brand and audience

• Appearance: Set your logo, colors, theme, and fonts in Customer Portal appearance, then adjust the Help Center layout

• Domain: Connect your own domain so customers recognize the address

• Languages: Publish articles in multiple languages

• Access: Use Help Center privacy controls to limit access to your site or selected articles

Help customers find answers

Customers can search your published content and use Ask AI to get answers with source links. Content access rules still apply. The Customer Portal FAQs explain the available sources and common search questions.

You can also bring help articles into your product through Messenger, and link or mention articles in customer conversations, Requests, and Updates.

For customers who use AI tools, provide Markdown and AI-readable documentation.

Improve your content

Use Documentation analytics to review article views and reactions. Update articles that do not answer customers' questions, and keep screenshots and instructions aligned with your product.

FAQs