Skip to main content
Version: 1.0.0

Document

The Document section stores project-related documentation and guides. These documents are written in Markdown format.

This guide explains how to manage documents for your project:

Create markdown​

Step 1: Click the "Create markdown" button on the right side of the menu bar.

btn-create-document.png Step 2: The system will display the "New" screen.

create-flow.png Step 3: Enter the required information in the form.

Field Descriptions:

Field NameMandatoryFormatConstraintsDescription
NAMEYesTextboxThe name of the document
DESCRIPTIONNoTextboxDetailed description of the document

Step 4: Click the "Create" button to create the document.

Edit markdown​

Step 1: Click the name of the markdown document you want to update.

btn-edit-document.png Step 2: The system will display the document content and the Edit button.

edit-document.png Step 3: Click the Edit button, and the system will display two sections:

  1. The editable content
  2. The preview of how it appears in the browser edit-document-save.png Step 4: Click the "Save & Close" button to update the content.

Rename​

Step 1: Click the "Rename" button in a row.

btn-rename-document.png Step 2: The system will display the "Update" screen.

rename-document.png Step 3: Enter the updated information in the form.

Field Descriptions:

Field NameMandatoryFormatConstraintsDescription
NAMEYesTextboxThe name of the document
DESCRIPTIONNoTextboxDocument description

Step 4: Click the "Update" button to save the new document name.

Delete markdown​

Step 1: Click the "Delete" button in a row.

btn-delete-document.png Step 2: The system will display a confirmation dialog.

delete-document.png Step 3: Click the "Yes" button to delete the document.