Create and Publish a Help Article

Before you start

• You need a staff role with the help.manage permission.

• Help Docs are organization-level content. The location picker does not change which articles belong to the gym.

• Decide who should be able to read the article before choosing visibility: public, member, or staff.

Create the article

1. Go to Staff > Help Docs.

2. Select New article.

3. Enter the Title. Topo can generate a slug from the title, or you can type a lowercase hyphenated slug yourself.

4. Choose the Kind: walkthrough for step-by-step work, guide for concepts, faq for short troubleshooting answers, or article for reference material.

5. Choose Visibility and Status. Start as draft if the article still needs review; choose published only when it is ready to be used.

6. Choose a Category or leave the article uncategorized temporarily.

7. Write a short Excerpt that explains when staff should use the article.

8. Write the Body in the TipTap editor, then select Create article.

Publish or revise

• After the article is created, open it from the article list and use Edit to revise metadata or body content.

• Use Publish when a draft is ready for staff or member-facing use.

• Use Archive when an article should no longer be active. Archiving is the normal way to remove old Help Docs content from active use.

Common errors and points of confusion

• The title is required and must be clear enough for search results.

• The slug must be unique inside the organization and should use lowercase letters, numbers, and hyphens.

• A staff-only published article is still internal; it will not appear on the public help page.

• A draft may be visible in the staff admin screen, but it should not be treated as a live policy article.

• If an article should support AI reply drafts, write direct answers and avoid vague references like ask a manager unless that is the actual policy.