Adding documentation (such as a user manual) helps users understand report metrics, data sources, or guidelines directly within Webdashboard.
Prerequisites & Licensing Requirements
[!NOTE] PDF documentation support requires a connection to a Microsoft Fabric Data Lake.
Standard License: Supports Text documentation only.
Hybrid / Enterprise License: Supports both Text & PDF documentation, provided the workspace is linked to a Fabric Capacity (rather than an Embedded Capacity).
How to Access the Documentation Manager
There are two ways to add or edit documentation for a report:
Option 1: Directly from the Report
Open the report you wish to document.
In the top action bar, click the Add Documentation icon (book icon).
Option 2: From the Settings Menu
Open the Settings menu and navigate to the Report Overview.
Locate your report in the list. Check the Actions column:
+(Plus icon): No documentation is currently attached. Click to add.Book icon: Documentation is already attached. Click to view or edit.
Adding or Updating Documentation
Depending on your subscription and capacity setup, select your preferred format tab:
Text: Enter or edit your documentation using the built-in text editor.
PDF: Select and link a PDF file stored in your connected Fabric Lakehouse directory.
Save your changes once finished.
Removing Documentation
To remove PDF documentation: Unlink or remove the selected PDF file.
To remove Text documentation: Clear all text from the editor field and save.
User Experience
Once documentation is added to a report, end users will automatically see an Information (i) icon in the top-right toolbar when viewing the report. Clicking this icon opens the attached manual or documentation panel.