Guide

Audience Paths

Use docspress/audience-paths to route readers into distinct documentation branches. Each path is a complete, keyboard-accessible card with its own title, summary, action, icon, accent, and destination.

When to use it

Choose Audience Paths when readers arrive with different goals, roles, or starting states. Good examples include “I already have docs” versus “I need to create docs,” or separate administrator, developer, and contributor journeys. Use ordinary links when the choices are secondary or differ only slightly.

Edit the block

Edit the section eyebrow, title, description, and card copy in the canvas. Use the sidebar to set each destination, icon, accent, and new-tab behavior. You can add up to six paths, select one to three columns, center or left-align text, show path numbers, reduce spacing with Compact layout, or choose a theme, paper, ink, or blueprint tone.

Use the spacious layout for a landing-page decision. Use Compact layout for a router inside an article. Point paths to normal WordPress Page roots so their child Pages form predictable sidebar branches.

Attributes

Reference

Audience Paths attributes

Section content and layout accepted by docspress/audience-paths.
10 fields
eyebrow string

Plain-text overline.

title string

Section heading.

description string

Section summary.

paths array required

One to six path objects.

columns number

Responsive column target.

tone enum

Panel treatment.

textAlign enum

Card content alignment.

compact boolean

Reduces panel spacing, card height, and type scale.

showNumbers boolean

Shows each path number.

panelColor / accentColor string

Optional hexadecimal color overrides.

Each paths item accepts:

Reference

Path object

Fields for one audience destination.
7 fields
title string required

Card heading.

description string

Short plain-text explanation.

url url

Destination. An empty URL renders a non-link card.

cta string

Action label.

icon string

Semantic icon ID selected in the editor.

accent enum

Card accent.

newTab boolean

Opens the destination in a new tab.

The icon selector includes documentation, code, site, AI, API, terminal, testing, troubleshooting, repository, security, operations, and other common documentation concepts. Legacy icon abbreviations remain compatible.

Creative examples

Choose by documentation state

Choose a starting point

Where are your docs today?

Follow the path that matches your repository.

Choose by role

Pick your workspace

What are you responsible for?

Start with the controls, examples, and checks that match your role.

Compact task router

Jump to a task

What do you need right now?

Use this compact router inside a longer operations guide.

Published behavior and accessibility

A destination card is one native link rather than nested links, so it works without JavaScript and has a predictable keyboard focus target. New-tab destinations receive safe relationship attributes. Empty URLs intentionally render static cards.

Keep the paths mutually exclusive enough that a reader can choose quickly. Start each title with the reader’s state or goal, keep descriptions parallel, and use consistent action labels.