Skip to main content
Documentation

Documentation overview

Publish customer help articles and API documentation in one site, with shared branding, navigation, and editing tools.

Written By Markus Palm

Last updated 14 minutes ago

Overview

Documentation is Featurebase's product for publishing customer help and developer documentation. It has two parts:

  • Help Center: Support articles and knowledge bases that help customers use your product

  • API documentation: Developer guides and an API reference generated from an OpenAPI spec

Both use the same site and navigation. You can publish help articles on their own or add API documentation alongside them.

The dashboard currently calls the shared editor Help Center. Open Help Center to manage your content.

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.

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


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 Help Center 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

They are two parts of Documentation. Use Help Center for customer support articles and API documentation for developer guidance. API reference means the generated endpoint pages.

The shared editor and some settings still use Help Center as their label. Documentation is the parent product name. Our setup instructions use the labels shown in the dashboard so you can follow them.

Open /sitemap.xml on your Help Center's custom domain, such as https://help.example.com/sitemap.xml. The Feedback Portal has a separate sitemap.

Sitemaps are cached for 15 minutes, so recent changes can take time to appear. Check that the article is published and that you are using the Help Center domain. Private Workspaces do not have a public sitemap.