> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/common-settings/documentation.md).

# Documentation

Configure the documentation tab, type, title, variables and external documentation link of an entry, a folder or a vault in Remote Desktop Manager.

The ***Documentation*** section controls the [Documentation](https://docs.devolutions.net/rdm/user-interface/content-area/dashboard/dashboard-tabs/documentation.md) dashboard tab of an entry: who sees it, the format of new pages, the tab title, how variables are resolved, and a link to documentation stored in another service.

Available for session, credential, information, document, contact, macro/script/tool, synchronizer and PAM entries, and for folders, with workspaces that support documentation: Devolutions Server, Devolutions Cloud, Microsoft SQL Server and the other database workspaces, and SQLite. In the entry properties, go to ***View*** – ***Documentation***.

### Documentation

<table><thead><tr><th width="220">SETTING</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><em><strong>Show documentation tab</strong></em></td><td>Defines whether the <em><strong>Documentation</strong></em> dashboard tab is shown: <em><strong>Inherited</strong></em>, <em><strong>Allowed</strong></em> or <em><strong>Disallowed</strong></em>. With <em><strong>Inherited</strong></em>, the setting of the closest parent folder that has one is used; when none has one, the tab is shown.</td></tr><tr><td><em><strong>Documentation type</strong></em></td><td>Format of new documentation pages: <em><strong>Inherited</strong></em>, <em><strong>Markdown</strong></em>, <em><strong>Plain text</strong></em>, <em><strong>HTML</strong></em> or <em><strong>Form</strong></em>. With <em><strong>Inherited</strong></em>, the type of the closest parent folder that has one is used, or <em><strong>Markdown</strong></em>. Shown when the workspace supports documentation types.</td></tr></tbody></table>

### External documentation

<table><thead><tr><th width="220">SETTING</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><em><strong>Service type</strong></em></td><td>Service that hosts the documentation: <em><strong>Confluence</strong></em>, <em><strong>Custom</strong></em>, <em><strong>Notion</strong></em> or <em><strong>SharePoint</strong></em>. With <em><strong>Default</strong></em>, the link of the closest parent folder, or of the vault, that sets one is used. With <em><strong>None</strong></em>, no external documentation is shown, including for the entries below that are set to <em><strong>Default</strong></em>.</td></tr><tr><td><em><strong>URL</strong></em></td><td>Address of the documentation page. Variables are supported. Select the <em><strong>Navigate</strong></em> button in the field to open the address in a web browser.</td></tr><tr><td><em><strong>Link</strong></em></td><td>Available for <em><strong>Notion</strong></em>. Opens a window that lists the recent Notion pages, with a search field. Select a page, then click <em><strong>Link</strong></em> to fill the <em><strong>URL</strong></em> field with its address.</td></tr><tr><td><em><strong>New page</strong></em></td><td>Available for <em><strong>Notion</strong></em>. Creates a Notion page: enter its <em><strong>Title</strong></em>, optionally select a <em><strong>Parent</strong></em> page, then click <em><strong>Create</strong></em>. The <em><strong>URL</strong></em> field is filled with the address of the new page.</td></tr></tbody></table>

When the ***URL*** field is filled, the page opens in a separate dashboard tab, named ***Confluence***, ***Notion***, ***SharePoint*** or ***External documentation*** according to the service type, or with the documentation title when one is set. This tab follows the ***Show documentation tab*** setting and is not available in offline mode. When the link is set on the entry itself, this tab takes the place of the ***Documentation*** tab; a link inherited from a folder or the vault is shown beside it.

{% hint style="info" %}
The ***Notion*** tab displays the content of the Notion page, with its ***Last updated*** date and the ***Refresh*** and ***Open in browser*** buttons. Signing in to Notion is required: click ***Sign in*** in the tab, in the ***Link*** or ***New page*** window, or in ***File*** – ***My account settings*** – ***Notion***, which also shows the connected ***Account*** and ***Workspace*** and offers ***Sign out***.
{% endhint %}

### Settings

<table><thead><tr><th width="220">SETTING</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><em><strong>Documentation title</strong></em></td><td>Name of the <em><strong>Documentation</strong></em> dashboard tab. Variables are supported. When the field is empty, the title set on the vault or in the workspace settings is used, or <em><strong>Documentation</strong></em> when none is set.</td></tr><tr><td><em><strong>Variable resolving</strong></em></td><td><p>Defines how <a href="https://docs.devolutions.net/rdm/concepts/intermediate-concepts/variables.md">variables</a> in the documentation pages are replaced by their values:</p><ul><li><em><strong>Default</strong></em>, <em><strong>Inherited</strong></em>: the setting of the closest parent folder that has one. When no parent folder has one, <em><strong>Simple</strong></em> is used.</li><li><em><strong>Simple</strong></em>: a limited set of variables. Environment variables and one-time password variables are not replaced.</li><li><em><strong>All</strong></em>: all the variables, except the password variables.</li><li><em><strong>None</strong></em>: no variable is replaced.</li></ul></td></tr></tbody></table>

The value that applies is shown in grey next to the settings set to ***Inherited*** or ***Default***.

With [batch edit](https://docs.devolutions.net/rdm/ribbon-menu-bar/edit/batch-edit.md), select ***Override*** to replace these settings on every selected entry.

The section is not shown for global PAM providers. By default, the section is shown only after selecting ***Show all properties*** in the entry properties.

### Vault documentation settings

For the vault, go to ***Administration*** – ***Vault settings*** – ***View*** – ***Documentation***. This section has different settings, which apply to the whole vault. It is shown when the workspace supports documentation.

<table><thead><tr><th width="220">SETTING</th><th>DESCRIPTION</th></tr></thead><tbody><tr><td><em><strong>Default template</strong></em></td><td>Content of new documentation pages: <em><strong>Tutorial</strong></em> (generated sample text), <em><strong>Empty</strong></em> or <em><strong>Custom</strong></em>.</td></tr><tr><td><em><strong>Template</strong></em></td><td>Custom template used for new pages. Available when <em><strong>Default template</strong></em> is set to <em><strong>Custom</strong></em>.</td></tr><tr><td><em><strong>Manage templates</strong></em></td><td>Opens the list of the custom templates of the vault, to add, edit or delete them.</td></tr><tr><td><em><strong>Documentation title</strong></em></td><td>Name of the <em><strong>Documentation</strong></em> dashboard tab for the entries of the vault that have no title of their own. Variables are supported.</td></tr><tr><td><em><strong>Documentation type</strong></em></td><td>Format of new documentation pages for the entries set to <em><strong>Inherited</strong></em>: <em><strong>Markdown</strong></em>, <em><strong>Plain text</strong></em>, <em><strong>HTML</strong></em> or <em><strong>Form</strong></em>.</td></tr><tr><td><em><strong>Style sheet</strong></em></td><td>Opens an editor for the style sheet applied to the documentation pages of the vault. Not shown when <em><strong>Documentation type</strong></em> is set to <em><strong>Plain text</strong></em>.</td></tr><tr><td><em><strong>External documentation</strong></em></td><td><em><strong>Service type</strong></em> and <em><strong>URL</strong></em> of the documentation for the whole vault, with the same <em><strong>Link</strong></em> and <em><strong>New page</strong></em> buttons as in the entry properties. The entries and folders set to <em><strong>Default</strong></em> use it when no parent folder sets a link. Shown when the workspace supports external documentation.</td></tr></tbody></table>

See [Documentation](https://docs.devolutions.net/rdm/concepts/intermediate-concepts/documentation.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.devolutions.net/rdm/knowledge-base/knowledge-base-articles/entry-settings/common-settings/documentation.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
