Managing Documentation

Documentations are containers of documentation pages. Each big topic of your project should be contained in a documentation.

Manage Sections

Documentation sections and API references live on the same Manage Sections page. To open it:

• In the editor top navigation, click on the section menu.

• Click the settings cog.

The left list groups sections under Documentation and API Reference headers. Select a documentation section to see and edit its settings on the right.

Creating Documentation

To create a documentation:

1. Open the section menu in the top navigation.

2. Under the Documentation group, click + New documentation.

3. Give it a title.

Publishing Documentation

Documentation by default are not published. To publish (or unpublish):

• Open Manage Sections.

• Select the documentation.

• Toggle Published in the Visibility card, or use the Publish / Unpublish button in the header.

When a documentation is unpublished, an Unpublished pill shows on the section menu and in the Manage Sections list.

Deleting Documentation

To delete a documentation:

• Open Manage Sections.

• Select the documentation.

• In the Danger zone card, click Delete section.

• Confirm your deletion.

Ordering Documentation

To change a documentation order in the picker:

• Open Manage Sections.

• Drag the documentation in the left list from the handle .

• Drop the documentation in the desired place.

You can only reorder within the Documentation group; drag-and-drop between Documentation and API Reference is not supported.

If the documentation is ordered first and is published, then it will be the default documentation to load for your readers.