Use docspress/troubleshooter for a short branching support, diagnosis, or onboarding flow. Readers answer yes-or-no questions, move back through their choices, and arrive at a semantic outcome.
When to use it
Choose Interactive Troubleshooter when the correct next step depends on a few observable conditions. Use Audience Paths for independent destinations and Flow for one linear procedure. If the tree needs more than 12 questions, split the problem or move it into a dedicated support application.
Design the routes
Give every question and outcome a stable unique ID. Set yesNext and noNext to another question ID or an outcome ID. Start with the condition that divides readers most usefully, and make every answer label describe the choice when “Yes” and “No” would be ambiguous.
DocsPress sanitizes IDs and adds suffixes to duplicates. An invalid startId falls back to the first question. An invalid destination shows an authoring warning instead of an empty panel, but it still leaves the reader without an outcome, so test every route.
Attributes
Interactive Troubleshooter attributes
docspress/troubleshooter.-
titlestring -
Plain-text troubleshooter heading.
-
introstring -
Formatted explanation before the first question.
-
startIdstring -
ID of the first question. Invalid values fall back to the first normalized question.
-
questionsarray required -
Up to 12 branching question objects.
-
outcomesarray required -
Up to 12 terminal outcome objects.
-
showProgressboolean -
Shows the reader’s progress through the current path.
No fields match this filter.
Each question contains id, question, yesLabel, yesNext, noLabel, and noNext. Each outcome contains id, status, title, and formatted content; status accepts success, neutral, warning, or error.
Creative examples
Find the next documentation workflow
Find the next step
Do you already have Markdown documentation?
Is the repository connected to WordPress?
Connect WordPress
Run the installer and verify the publishing target.
Publish the docs
Run a draft sync and review the rendered Pages.
Generate a starter
Create source-grounded Markdown documentation first.
This answer needs a valid destination.
Edit the block and connect this answer to another question or outcome.
Diagnose a stale preview
Why does the preview look stale?
Does the local Markdown contain the expected change?
Did the latest synchronization finish without conflicts?
Does a cache-bypassed request show the new content?
Update the source first
Make the reviewed change in Markdown, then preview the generated Page.
Resolve synchronization
Read the conflict or error detail before attempting another publish.
The publish succeeded
The origin is current. Allow the edge cache to refresh and avoid duplicate writes.
Inspect the managed Page
Confirm the expected Page ID, source key, and rendered block content.
This answer needs a valid destination.
Edit the block and connect this answer to another question or outcome.
Choose a code-example block
Which code block should I use?
Should readers execute or edit the example in the page?
Is the example an HTTP request?
Are there equivalent versions of the same example?
Use API Request / Response
Show the method, endpoint, headers, body, and guarded runner together.
Use Live Code Playground
Keep the HTML, CSS, and JavaScript self-contained and sandboxed.
Use Code Tabs
Give every tab the same task and expected result.
Use Colorful Code
Highlight or annotate only the lines the explanation depends on.
This answer needs a valid destination.
Edit the block and connect this answer to another question or outcome.
Published behavior and accessibility
The active question or outcome is the only visible panel. Back and Start over preserve a clear recovery path, focus moves to the new heading, and progress changes use a live announcement. Controls are real buttons and the authored content remains in the Page source.
Walk every possible route before publishing, including Back and Start over. Phrase questions around facts the reader can know, and make every outcome name the next action.