Managing Documentation
Documentation serves as a container for various documentation pages. Each major topic within your project should be organized into its own dedicated documentation section. This structure helps ensure clarity and accessibility for users navigating through the information.
Creating Documentation
To create a documentation:
- Click on Documentation
in the sidebar. - Click on "Create new documentation".
- Give it a title.
Publishing Documentation
By default, documentation is not published. When you are prepared to publish or unpublish, please follow these steps:
- Click on Documentation
in the sidebar. - Below the documentation title at the top, click on the publishing state and modify it as needed.
When a documentation is published and visible to readers (because its version is also published), it will be indicated by a green dot
Deleting Documentation
To delete a documentation:
- Click on Documentation
in the sidebar. - Select the documentation to delete.
- Click on the red bin
next to the Documentation title at the top. - Confirm your deletion.
Once documentation is deleted, it cannot be retrieved. Please ensure that you have saved any necessary copies before proceeding with deletion.
Ordering Documentation
To change a documentation order in the picker:
- Click on Documentation
in the sidebar. - Drag the documentation to be ordered from the handle
- Drop the documentation in the desired place.
If the documentation is arranged in a specific order and is published first, it will serve as the default documentation that loads for your readers.