Configurations
How to Sort & Organize Documentation in WeMakeSuccess
How the knowledge base category and article ordering works, for admins managing platform docs.
This article covers how documentation is organized on the platform-level knowledge base (the docs you're reading now) — categories, article ordering, and status.
Categories
Each documentation article belongs to exactly one category (for example, "Getting Started" or "Integrations"). Categories appear on the docs homepage as cards, ordered by their order field — lower numbers appear first.
- Go to the Knowledge Base section in the admin panel and open Categories.
- Create a category with a name, URL slug, description, an icon, and an order number.
- Existing categories can be reordered by editing their order number — there's no drag-and-drop reordering, so set numbers with gaps (10, 20, 30) if you expect to insert categories later.
Articles
Within a category, articles are also sorted by their own order number. Each article has:
| Field | Purpose |
|---|---|
| Title | Displayed as the H1 on the article page and in search results |
| Slug | The URL path — changing it breaks any existing bookmarks or inbound links to the old URL |
| Description | Shown under the title and used as the search result snippet |
| Status | Draft (hidden from the public docs site) or Published (live) |
| Order | Position within its category |
Table of Contents Generation
Each article automatically generates a table of contents in the right-hand sidebar from its H1, H2, and H3 headings — you don't need to build this manually. This is also why heading structure matters: skipping levels (jumping from H2 straight to nothing, or using bold text instead of a real heading) means that section won't appear in the on-page navigation.
Draft first, publish when ready. Save new or heavily-edited articles as Draft while you review them — drafts are completely invisible on the public /docs site, so there's no risk of half-finished content going live.
Was this article helpful?