Skip to content
Corex

GuideStep

Corex\Guides\GuideStep · class · Add-ons layer

One numbered instruction (spec 084, FR-007). $instruction and $result are separate fields rather than one paragraph because the pair is what makes a step checkable: the reader does the first and can tell whether it worked from the second. A guide written as prose reads fine and leaves somebody stuck halfway with no way to know whether they are stuck. $warning is for the steps that are hard to undo. It renders before the instruction, not after — a caution a reader meets once they have already done the thing is decoration.

__construct(string $instruction, string $result, string $warning, ?GuideScreenshot $screenshot)

Section titled “__construct(string $instruction, string $result, string $warning, ?GuideScreenshot $screenshot)”

The step’s words, for the screen’s client-side search.