Docs
Help center
Answers your customers can find, in your theme, on your domain and inside your app.
Write articles#
Open Help center in the dashboard. Create a title, then write in Markdown on the left and watch the article as readers will see it on the right. Start with the answer in one sentence; use headings for steps so long articles get a table of contents.
Group articles into collections (for example Getting started or Billing) and move them up and down. Deleting a collection keeps its articles. The short answer field is what search results show; leave it empty to use the first lines.
Publish#
An article is a draft until you publish it. Once one is published, a Help tab appears on your public pages, at /help on your Shipnoted address or on your own domain. Each article has its own address that never changes once published, a canonical link, and structured data for search engines.
In the widget#
With published articles, the widget gains a Help tab that lists the most helpful articles and searches as you type. When someone starts writing a new idea, matching articles are suggested above the list of similar requests, so a question that has an answer never becomes a duplicate request.
The same data is available to your own UI: GET /api/public/<slug>/help?q=export returns matching articles as JSON.
What it tells you#
- Was this helpful? Each reader answers once and can change their mind. The dashboard shows the helpful rate and flags articles that more people marked unhelpful than helpful.
- Searches with no answer. Searches from the widget that found nothing are counted over the last 30 days: the list of articles you have not written yet.
- Views per article.
Limits#
Free holds 25 articles, Pro 500 and Team 2000. Readers, searches and widget loads are never counted. Your own domain is part of Pro and Team.