DocsPress

on WordPress

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, accent, and destination. Icons and visible bottom actions are optional for the whole block.

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, hide icons, hide bottom links, 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.
12 fields
eyebrow string

Plain-text overline.

DefaultChoose a starting point
title string

Section heading.

DefaultWhere are your docs today?
description string

Section summary.

DefaultFollow the path that matches your repository.
paths array required

One to six path objects.

DefaultTwo starter paths Values1–6 items
columns number

Responsive column target.

Default2 Values1, 2, 3
tone enum

Panel treatment.

Defaulttheme Valuestheme, paper, ink, blueprint
textAlign enum

Card content alignment.

Defaultleft Valuesleft, center
compact boolean

Reduces panel spacing, card height, and type scale.

Defaultfalse Valuestrue, false
showNumbers boolean

Shows each path number.

Defaultfalse Valuestrue, false
showIcons boolean

Shows the decorative icon badge on every path.

Defaulttrue Valuestrue, false
showLinks boolean

Shows the bottom action row. Hiding it does not disable the card destination.

Defaulttrue Valuestrue, false
panelColor / accentColor string

Optional hexadecimal color overrides.

Values#RRGGBB

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.

Defaultblue Valuesblue, gold, coral, green
newTab boolean

Opens the destination in a new tab.

Defaultfalse Valuestrue, false

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.

I already have Markdown docs

Connect an existing docs folder to WordPress and begin with a safe draft sync.

Publish existing docs

I need to create docs

Generate source-grounded documentation with AI, review it, then publish it.

Create docs with AI

Choose by role

Pick your workspace

What are you responsible for?

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

I build integrations

Learn endpoints, authentication, webhooks, and safe retry behavior.

Open developer docs

I run the site

Configure publishing, navigation, search, and editorial access.

Open administrator docs

I contribute fixes

Set up the repository, run checks, and prepare a reviewable change.

Open contributor docs

Compact task router

Jump to a task

What do you need right now?

Use this compact router inside a longer operations guide.

Call the API

Build and inspect a request.

API examples

Run a command

Copy a verified terminal workflow.

Terminal steps

Trace a failure

Follow symptoms to the next check.

Troubleshoot

Tune performance

Measure first, then change one variable.

Performance guide

Text-only paths without icons

Use a single compact column when the wording should carry the decision and decorative icon badges would add noise.

Choose a reading path

How do you want to learn?

Start with an explanation or move directly into a guided task.

Understand the model

Learn the concepts, boundaries, and vocabulary before changing a project.

Read the concepts

Build the first version

Follow a small end-to-end example and verify the result as you go.

Start the tutorial

Linked cards without bottom actions

Hide the repeated action row when concise three-column cards already make their destinations clear. The full card remains clickable.

Browse the reference

Choose an area

Each complete card opens its matching reference section.

Configuration

Review supported settings and defaults.

Authentication

Choose credentials and protect secrets.

Troubleshooting

Match symptoms to the next diagnostic check.

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. Turning off Show bottom links removes only the visible action row; the card remains linked and the readable Markdown fallback keeps its destination. Turning off Show icons removes decorative badges without removing information. 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.

Was this helpful?