FAQs

FAQs let you collect common questions and answers for a collection. You can write them yourself or let AI suggest them from your docs or notes. AI suggestions stay pending until you approve them.

#

Open FAQs

Open a collection and click FAQ in the left sidebar. A red badge on the icon shows how many AI suggestions are waiting for review.

The page has two views:

  • Live FAQs: approved FAQs that readers can see.
  • Pending: AI suggestions waiting for review. This tab only appears when there are pending FAQs.
#

Add an FAQ by hand

  1. In the Add FAQ box, choose Manual.
  2. Enter the question and the answer.
  3. Under Tags, type a tag and press Enter. Add as many as you need.
  4. Click Add FAQ.

Manual FAQs go live right away. If DocStar finds a similar FAQ, a Similar FAQ Found window opens. Choose Update this to edit the existing FAQ, Save as new to keep both, or Cancel.

#

Generate FAQs with AI

  1. In the Add FAQ box, choose AI Generate.
  2. Paste your source text: a help article, feature description, release notes or rough notes.
  3. Click Generate FAQs.
  4. The suggestions appear under Generated FAQs and are saved as pending.

If the text has nothing FAQ-worthy, DocStar tells you no FAQs could be generated.

#

Review pending FAQs

Open the Pending tab. Suggestions are grouped into two kinds:

Label Meaning Your options
New A question you don't have yet Approve or Reject
Update A better version of an existing FAQ, shown as a preview of the changes Approve Update, Create as New or Reject

You can click Edit before approving to change the question or answer first. Reject deletes the suggestion. Nothing goes live until you approve it.

#

Edit, tag and delete live FAQs

On the Live FAQs view:

  • Use Search FAQs... to find a question.
  • Click a tag at the top to show only FAQs with that tag.
  • Click Edit to change the question, answer or tags, then Save.
  • Click Delete to remove an FAQ.

Tags also help DocStar match FAQs to the right published pages.

#

Where readers see FAQs

Approved FAQs appear in three places:

  • The FAQ page on your docs site at /faq (for example docs.example.com/faq). Click View Public FAQ to open it.
  • At the bottom of published pages, under Frequently Asked Questions. DocStar shows FAQs that match the page's tags and title. Readers can expand an answer or copy a link to it.
  • AI answers: Ask AI and chat widgets on your docs use approved FAQs to answer questions.
#

Generate FAQs through the API

You can send text to the DocStar API to create pending FAQs in the background, with an optional webhook URL. When generation finishes, DocStar posts the pending FAQs and a referenceId to your webhook. You still approve them in the app. If the webhook call fails, the FAQs are still waiting in the Pending tab.

Click How it works → API on the FAQ page for the API reference. You'll need an API token.

#

Good to know

  • FAQs belong to one collection.
  • FAQs aren't available in Embed collections.
  • DocStar checks for duplicates and offers to improve existing FAQs instead of adding near-copies.
Built with DocStar