Documentation

Write and add text as documentation for solutions and resources in the Polyteia Platform.

The documentation feature allows resource owners and solution administrators to provide detailed context about the created resource or solution. This can be, for example, a more detailed description of a dataset or the purpose, meaning, and classification of an entire solution.

Where to find the documentation function

• On the Overview page of a dataset

• On the Overview page of a form

• On the Overview page of a solution

Click on the small ✏️ button next to the Documentation section to open the editor.

Using the editor

The editor supports flexible content blocks. To add a block, hover over the line where you want to add the block, click on the ➕ symbol that appears on the left side, or press / to open the block menu. To move a block, use the dotted button next to the line that appears next to the ➕ symbol.

Available blocks

Block type	Description
Text	Start typing plain text
Heading 1	Large section heading
Heading 2	Medium subheading
Heading 3	Small subheading
Table	Create a simple 2D table
Accordion	Collapsible content for long sections
Bulleted list	Unordered list of items
Numbered list	Ordered list of steps or points
Todo list	Add checkboxes for task tracking
Callout	Highlight a tip or important note
Blockquote	Add a quote or remark with visual emphasis
Code	Display snippets of code or commands
Divider	Visually separate sections
Embed	Embed media like videos, maps, or links

Tips

• You can combine multiple blocks to structure your notes

• Use headings and dividers to organize longer documentation

Your documentation is not automatically saved. Please always save it after updating with the small save icon next to the Documentation heading.