> For the complete documentation index, see [llms.txt](https://docs.tivity.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tivity.one/building-an-application/application-setup/documentation.md).

# Documentation Management Tool

## Overview

Sometimes it is necessary or desirable to provide a description of how an application works and how to use it. The user of this app can then read this published text at any time.

![Help App in workspace](/files/-MZE1ySPCZXordeeZk03)

## Getting started

Navigate to your **Workspace > Apps** and click on the gear icon<img src="/files/-MBCo7T7BtG64Zwffv31" alt="" data-size="line"> to activate the configuration mode of your applications. Next, click on the gear icon<img src="/files/-MBCo7T7BtG64Zwffv31" alt="" data-size="line"> of the application you wish to configure. In the **App** section you click on **Documentation** to access the documentation management window.

![Documentation overview](/files/-MZE3vAlAFoLWpAQUWKs)

## Manage documents

The documentation management window gives you a good overview of the pages already created and the structure of this document. You can filter, expand ![](/files/reNTlonXBXqXketLtcWI)or collapse ![](/files/jC6RHKOV5foR6bQVdRrs) all existing pages, use the Import/Export buttons to download a CSV file and upload it again after editing and add new pages.

<figure><img src="/files/vDwWo5Ef5Za4ENaKvOTA" alt=""><figcaption><p>Pages Management</p></figcaption></figure>

In addition, it is possible to reorder the pages by drag and drop:

<figure><img src="/files/SptaT2vlijoIvPYw1oJQ" alt=""><figcaption><p>Reordering Pages</p></figcaption></figure>

Pages can be reordered into the root and can be reordered into other parents (as a child). If the page has children, when the page is reordered, then all children are reordered with it.

## Edit pages

To edit a page, select a page from the overview. The **Documentation Designer** will open. The previously created content appears in three different views.

Content views sections:

* Editors (1) - WYSIWYG HTML editor with toolbox and markdown editor
* Preview (2) - view that the app user also sees
* Contents (3) - table of contents of this page

![WYSIWYG Editor](/files/-MZJ6ZO6k9E1LCmvG-rH)

### Editors

Two editors are offered for editing the content. The first one is the **WYSIWYG editor** (tab Easy Editor), with which the direct editing of the text formatting is possible. With the help of the toolbox you can easily select the styles. You will see the changes immediately in the preview. In addition, images can be added to the page (toolbox: Insert->Image).

As an alternative there is a **Raw Editor**. This is located in the second tab in the editor section (1). With this editor Markdown text can be entered or copied. Of course, the changes are also changed immediately in the preview.

![Raw Editor](/files/-MZJFfBvx6IB_RYUBukZ)

### Attachments

Attachments can be added to each page. For this purpose, there is an area at the bottom of the editor to fold up. There appears an upload button with which you can attach all possible files. See next picture under # 1 (Documentation Designer).

## Save and publish

To **save** the changes made to the page press the button on the right in the footer (4). You can also **delete** the page. To do that use the 'Delete Page' button in the footer on the left (2).

![Documentation Designer](/files/-MZTF51rvTUwJ70gmjLo)

After the page is saved, it is not yet available to the user of this workspace. He cannot see it. To do this, the page must first be published.\
To see immediately if the edited page is published, there is an indicator in the footer (3). If *not published* is displayed there, the page is not yet published. Otherwise, the date when the page was last published is there.

To **publish**, the action *Publish Page* must be selected in the context menu at the top right.

## Using documentation

After the content is published, a user of this workspace (view mode) can also read the created documentation. The standard app **Help** is provided for this purpose.\
After opening this app, all created documents of this workspace will be displayed. This means that the documents from all workspace apps are listed one below the other in the **Help** app.

![Help application](/files/-MZE1ySPCZXordeeZk03)
