Documentation hub

Turn the hub on

The hub is the Documentation Base Page plus a Documentation Explorer on that page.

  1. Put Documentation Explorer on a published page (inside a Section)
  2. Go to Appearance β†’ Customize β†’ Dirigible Documentation β†’ Documentation
  3. Choose that page as Documentation Base Page
  4. Publish

Leave Documentation Base Page empty if you do not want hub routing. Taxonomy archives then stay on their own URLs. With the hub on, those archives redirect to the hub β€” do not send people to type, product, or brand archives as the main library.

Filter URLs

Filters append to the hub path: type, product, and brand, each followed by that term’s slug. You can combine them. Examples:

  • /documentation/type/manuals/
  • /documentation/product/dehumidifier/
  • /documentation/type/manuals/brand/quest/

Explorer updates the URL as visitors pick filters. Combined filters and search results are kept out of search indexes.

On the hub, a Viewing: line names the active type, product, or brand. Reset filters clears search and those filters. Those controls are on the page, not in the block sidebar.

If a filter URL 404s after you first set the base page or change that page’s slug, go to Settings β†’ Permalinks and save to flush rewrite rules.

Search

Turn on Show Text Search in the Explorer sidebar (on by default). The search box filters the listing on the hub.

Cards vs Tiers

Explorer Layout is Cards (default) or Tiers.

  • Cards β€” a grid of doc cards. Show Excerpt and Grid Gap apply here.
  • Tiers β€” grouped rows. Columns (1, 2, or 3) appears when Tiers is selected.

Tips

  • Set Documentation Source if this Explorer should start from one type, product, or brand instead of the full library.
  • Type, product, and brand filter controls each have their own Show toggle in the sidebar.
  • Single docs link back to All Documentation when a base page is set.