Skip to main content
Skip table of contents

Perform a Document Health Check

Scroll Documents offers a health check to identify potential issues with your document and its pages. We recommend performing this check regularly, especially before key actions like saving a version, adding translations, or publishing, to catch and resolve any potential issues early.

What Is a Health Check?

Think of a health check as a diagnostic tool, it highlights areas within your document that may need attention. These can range from page-specific improvements to suggestions for optimizing your overall Scroll Documents setup.

The health check does not make any changes to your document or its pages, it simply identifies potential issues or improvements. Whether you act on these suggestions is entirely up to you.

To view all available checks in Scroll Documents and understand what they mean, see: Available Document Health Checks

Health checks are optional but recommended for maintaining a reliable document setup.

Prerequisites

Before you perform a health check, make sure:

  • You can view all pages in the document (meaning, no page restrictions prevent your access to any page).

  • You have space permissions to view pages and add attachments.

How To Perform a Health Check

To perform a health check of your document, follow these steps:

1. Navigate to the Document Manager of your document

  1. Click Scroll Documents from the space sidebar.

  2. From the Document Library, click the document card of a document.

Or

  1. From a page in a document, click Scroll page details.

  2. Ensure the Document toolbox tab is selected.

  3. Click Manage (cog icon).

2. Perform the Health check

  1. In the Document Manager, click More document actions (•••).

  2. Select Perform health check.

  3. Click Check to start the health check.

  • If any issues are found, the dialog will display the number of issues, and a warning icon will appear next to the checks that failed.

  • If no issues are found, you'll see the message:
    “Health check completed. 0 issues found.”

  1. (Optional) To download a report of the check, click Get report. This will download the results as a .json file.

  2. When you're done, click Close to exit the dialog.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.