Document Browser
The Document Browser lets you download your generated Salesforce documentation from within the aprity app. It appears inside the scan details panel on the Analyses tab after a scan completes.
Layout Modes
The Document Browser has two layout modes, controlled by where it is embedded in the app:
Compact Mode
In compact mode, the Document Browser renders as a flat row of download buttons without any surrounding container. This layout is used when the browser is embedded inline within other components.
Full Mode
In full mode, the Document Browser renders inside a bordered panel with a Documentation heading and a Refresh button. Download buttons are centered below the header. This layout is used when the browser is displayed as a standalone section within scan details.
Downloading Documentation
Each completed scan produces documentation in the format(s) selected during analysis configuration. One download button appears per available format, labeled with the file count (e.g., "Download HTML (3)").
Available Formats
| Format | File Type | Description |
|---|---|---|
| Markdown | .zip | Archive containing individual Markdown files organized by object. |
| HTML | .zip | Archive containing self-contained HTML files with embedded styles. |
| DOCX | .zip | Archive containing Microsoft Word documents with branded formatting. |
.zip | Archive containing PDF documents ready for distribution. |
Click the corresponding download button to save the ZIP archive to your local machine.
Only formats that were selected during scan configuration appear as download buttons. To generate additional formats, run a new scan with the desired output formats selected.
Trial Plan Behavior
Users on trial plans see all download buttons in a disabled state. A message below the buttons reads: "ZIP download is available on Starter plan and above."
Upgrade to a paid plan to unlock documentation downloads.
After upgrading, all documentation from previous scans becomes available for download immediately.
Refreshing Documentation
In full mode, click the Refresh button (circular arrow icon in the panel header) to reload the documentation index. This is useful if a scan has completed since you last opened the panel.