Documentation

Updated

Overview

Documentation has two site-wide settings. Documentation Base Page is the public library once it contains a Documentation Explorer. Documentation Site lets Product Downloads list another Dirigible site's documents.

Where to find these settings

Go to Documentation → Settings and find Documentation.

These settings used to be under Appearance → Customize → Dirigible Documentation. They moved with the same values, so there's nothing to set again, and old links to the Customizer open the new page.

Settings

  • Documentation Base Page: the published page that serves as your documentation hub. Leave it empty if you do not want a hub.
  • Documentation Site: the address of another Dirigible site (starting with https://). Product Downloads blocks set to Source: Documentation site list that site's documents. Leave it empty to use only this site's documents.

Select Save Settings at the bottom of the page. You need an Administrator or Manager account.

Tips

  • Put Documentation Explorer on the page before you select it here.
  • Filter URLs switch to a new base page when you save. If they show “page not found” anyway, go to Settings → Permalinks and click Save Changes.
  • Pages the site has already cached can take a little while to show a change.

Settings

Documentation

Documentation base page

The published page that becomes your documentation hub and turns on filter URLs. Leave it empty if you do not want a hub.

Documentation site

Address of another Dirigible site, such as your sister brand's, whose documents Product Downloads can list. Leave it empty to use only this site's documents.

Built by Dirigible Studio. Get in touch