Build a docs area
At the end of this guide your site has a docs area: a docs home with doc pages under it, a sidebar that lists them in your order, and previous and next links between them.
A docs area is a Docs home with Doc page pages under it. The docs home is a full-width page like any other, for example /help. Doc pages sit under it, or under another doc page, up to three levels below the docs home: /help/start/install/linux is as deep as it goes.
Each published doc page shows:
- a sidebar listing the doc pages of its docs area, with the current page marked;
- a breadcrumb of the pages above it;
- the page's title as its main heading, then its content;
- links to the previous and next doc pages;
- an On this page list of the page's Heading blocks.
On a phone, the sidebar folds behind a Menu button.
A site can hold several docs areas, such as one for customers and one for suppliers. Each has its own sidebar.
- Open Pages and choose New page.
- Under Type, choose Docs home.
- Type a Title, such as "Help", and check the Slug.
- Choose Create page.
Build the docs home like any page, with the blocks (the sections of a page) you like: an introduction, links to the main topics, a contact band.
- Choose New page and pick the Doc page type.
- Under Parent, choose the docs home or another doc page. "Only a docs home or a doc page. A doc page sits at most three levels below its docs home."
- Type the Title and choose Create page.
If the site has no docs area yet, the dialog says "Create a docs home first" and offers New docs home.
A doc page offers Text, Figure, Section, Spacer and Embed, plus five blocks made for documentation:
| Block | What it is for |
|---|---|
| Heading | A level 2 or level 3 heading. It appears in On this page, and readers can link straight to it |
| Code block | Commands or code readers copy, with a Language label and a copy button |
| Callout | A short remark set apart, with the Tone Note, Tip, Warning or Danger |
| Table | Two to six columns under a header row, up to 50 rows |
| Tabs | Two to five tabs, each a label over a text panel, for alternatives such as one per platform |
The docs blocks fit posts and ordinary pages too.
- In the editor, click an empty part of the canvas so the right panel shows the page settings.
- In the Doc page section, type a Sidebar label if the title is too long for the sidebar. "Leave it empty to use the title."
- Set Previous and Next: Automatic follows the sidebar order, None hides the link, or pick another page of the same docs area.
- Choose Save.

A new doc page goes last among its siblings. To move it:
- On the Pages screen, open the doc page's row menu. In the editor, use the Pages panel.
- Choose Move up or Move down. At either end, the button is disabled.

To place a page under another parent, choose Move in its row menu.
Publish doc pages as any page. See Publish changes. Publishing one doc page also refreshes the sidebar and the previous and next links on the other pages of its area, and the dialog says so. A doc page that is not published does not appear in the sidebar of the live site.
