Collections group your articles, such as "Getting started" or "Billing". Tabs split your docs into separate sets, such as "Guides" and "API", each with its own collections. Everyone on your team can arrange them in Docs.

How your docs are arranged

The tree on the left of every Docs page shows your tabs, their collections and the articles in each, in the order readers see them. The Docs page itself shows the same, with each article's views in the last 30 days and how many readers found it helpful.

On your portal:

  • Each collection gets a card on its tab's overview, and a page listing its articles.

  • With two or more tabs, they show in a row under your portal's header. The first tab is your docs' home, at /docs.

  • Articles in no collection show on the first tab, under the collections.

To jump to an article or collection by name in the app, press ⌘K (Mac) or Ctrl+K (Windows). See Find your way around.

Add a collection

  1. Select Add content → New collection, or the + beside a tab or collection in the tree, then New collection.

  2. Fill in the dialog:

    • Name: up to 60 characters.

    • Add icon: an optional icon shown beside its name.

    • Description: optional, up to 300 characters, shown in your docs.

    • Parent collection: another collection to put it in, or None (top level). Collections go up to 5 levels deep.

    • Tab: which tab it's in. A collection inside another is in that one's tab.

    • Who can read: see Choose who can read each page.

  3. Select Add collection.

Change or delete a collection

Open the collection from the tree and select Settings. The Details card has its name, icon, description and parent collection, and Access has who can read it. Select Save. When you rename a collection, its address changes too, and links to the old one keep working.

To delete it, open More actions (⋯) on the collection's page and choose Delete. Its articles stay, without a collection. Collections inside it move up a level, in its place.

Add a tab

Select New tab at the bottom of the tree, enter a name of up to 40 characters, and select Add tab.

Your first tab takes all the collections you already have. Move them to other tabs afterwards.

Choose what a tab opens on

Open the tab from the tree. Its page has three parts:

  • Content: its collections, and on the first tab the articles in no collection.

  • Access: who can read the tab and everything in it.

  • Settings: its name, its address and its landing page.

A tab's Settings: Name, Address and the three Landing page choices

The Address follows the tab's name. The first tab's is always /docs.

Landing page chooses what readers get when they open the tab:

  • Overview: a card per collection, with the tab's popular articles above them if you show them (see Docs home).

  • First item: the tab's first article, in the tab's order. Each reader gets the first one they can read; with none, the overview.

  • A page you choose: pick any article or collection in the tab under Page. Readers who can't read it (a draft, or a collection only some groups can read) get the overview instead.

Select Save.

Delete a tab

Open the tab, then More actions (⋯) → Delete. Its collections move to the tab before it, with their articles, and keep who can read them.

The first tab is your docs' home, so it can't be deleted while you have others: move another tab to the top first. Deleting your only tab takes your docs back to one page with all your collections.

Reorder and move things

Drag a tab, collection or article in the tree to where it should go. Or select its handle (⋮⋮), which also works from the keyboard:

  • Move up and Move down within its list.

  • Move to… another collection, Top level, another tab (Tab: and its name), or for an article No collection.

The tree with a collection's Move up, Move down and Move to… menu open

Each move applies at once, and readers see the new order straight away. Moving a published article to another collection in the tree goes live at once too, unlike changing its collection in its settings.