Customize the documentation URL for builder

Starting at version 1.21, developer edition of Experience Builder supports customizing the documentation URL used by the Help links in the builder environment. This is useful for offline or internal deployments where you want the documentation links to point to a custom documentation site instead of the default one.

To do this, specify a custom documentation URL in the setting.json file as below:

1
2
3
{
  "customDocumentationBaseURL": "[deployment URL]"
}

Steps

1. Navigate to the root directory of Experience Builder Developer Edition.
2. Find and open the setting.json file.
3. Locate the following key: "customDocumentationBaseURL": ""
4. Replace the empty value with a valid documentation base URL.
5. Save the setting.json file.
6. Launch Experience Builder Developer Edition.
7. In Builder, navigate to different areas that contain documentation (Help) links.
8. Click the documentation links.

Expected result

All documentation links in Builder should be directed to the configured customDocumentationBaseURL. The customized documentation URL should be used consistently across all supported documentation links.