Content
Documentation hubs
Build multi-page documentation sets on your API Portal. Each hub holds linked pages with a navigation sidebar. The number of hubs you can create is limited by an allowed-hubs count.
A documentation hub is a multi-page documentation set on your API Portal. You manage hubs under Content, Documentation. Each hub is a content collection of type documentation whose pages are linked in order and shown with a navigation sidebar.
How do you create a documentation hub?
Go to Content, Documentation and choose Add another hub. Give the hub a name and a slug. Open the hub to start adding pages. The add-hub control is disabled once you reach your allowed number of hubs.
- Open Content, Documentation.
- Choose Add another hub.
- Enter a name and a slug for the hub.
- Open the hub to add and arrange its pages.
- Choose Save changes in the hub editor.
What is the slug format for a hub?
A hub slug must be 3 to 50 characters, use only lowercase letters, numbers, and hyphens, and cannot start or end with a hyphen. Each hub slug must be unique across your hubs.
| Rule | Requirement |
|---|---|
| Length | 3 to 50 characters. |
| Characters | Lowercase letters, numbers, and hyphens only. |
| Hyphens | Cannot start or end with a hyphen. |
| Uniqueness | Must not match another hub's slug. |
How do you add and arrange pages in a hub?
Open a hub to reach its Documentation Settings view. A sidebar lists the hub's pages, and you add, edit, and order pages there. Pages are linked in sequence, so each has a previous and next page. Choose Save changes to apply your edits.
Each page's address is built from the hub slug as /docs/hub/hub-slug/page-slug. If a page slug does not match this pattern, the editor flags it and corrects it for you when you save, then shows a notice of what changed.
What does Show all pages in single view do?
Show all pages in single view switches a hub between paginated pages and one continuous page. On, the hub's pages render as a single continuous view. Off, they render with pagination. The toggle sits above the hubs list.
This setting applies to how readers move through the hub on the portal. Paginated mode shows one page at a time with navigation between them. Single view stacks the pages into one scrolling page.
Where do documentation hubs appear on the portal?
The default hub named Documentation appears at /docs. Any other hub appears at /docs/hub/its-slug, and each page within it appears at /docs/hub/its-slug/page-slug.
| Hub | Portal address |
|---|---|
| The default Documentation hub | /docs |
| Any other hub | /docs/hub/hub-slug |
| A page inside a hub | /docs/hub/hub-slug/page-slug |
How do you rename or delete a hub?
In Content, Documentation, open the row menu and choose Edit to rename a hub and change its slug inline, then choose Update. Choose Delete in the row menu to remove a hub, then confirm.
The default Documentation hub locks its Edit and Delete actions. You can still manage its pages from the hub editor.
Troubleshooting
| What you see | What to do |
|---|---|
| Add another hub is disabled | You have reached your allowed number of hubs, or your account lacks the role to manage content collections. The list shows the maximum when the limit is reached. |
| The slug shows a length error | The slug is shorter than 3 or longer than 50 characters. Use a slug within that range. |
| The slug shows a character error | The slug has characters other than lowercase letters, numbers, and hyphens, or starts or ends with a hyphen. Adjust it. |
| The slug says it must be unique | Another hub already uses that slug. Choose a different one. |
| A toast warns about malformed slugs | One or more page slugs do not match the hub path. They are corrected automatically when you save. |
| Edit and Delete are disabled on a hub | It is the default Documentation hub. Manage its pages from the editor instead. |
Where to next
Content overview
See everything you can publish on your portal beyond product docs.
Articles and collections
Publish standalone posts grouped into collections instead of a documentation set.
Media repository
Upload the images your documentation pages link to.
Portal pages
Create the standalone pages of your API Portal.