Use docspress/result to summarize the outcome of a procedure, validation, deployment, or diagnostic check. It combines semantic status, a heading, formatted explanation, and compact metadata.
When to use it
Choose Result after readers perform an action and need to recognize the expected state. Use Callout for advice or risk that exists independently of a procedure. Do not use success styling as decoration when no result has occurred.
Attributes
Result attributes
docspress/result.-
statusenum -
Semantic outcome state.
-
titlestring -
Formatted result heading.
-
contentstring -
Formatted explanation of the outcome and next step.
-
metastring -
Compact plain-text evidence such as a command, count, or duration.
No fields match this filter.
Status guide
| Status | Use it when |
|---|---|
success | The intended task completed |
neutral | The check produced information without a pass or fail |
warning | The task completed partially or needs attention |
error | The task failed or cannot continue |
Creative examples
Completed package verification
Lint, tests, and the Action bundle completed.
Partial synchronization
The safe changes were published. Three Pages remain drafts because their source changed in WordPress and GitHub.
No-op deployment
The desired Markdown tree matches every managed WordPress Page, so no writes were necessary.
Published behavior and accessibility
The block renders a semantic result summary. Its status remains identifiable through text and structure rather than relying on icon shape or color alone; the icon is decorative.
Name the completed action in the title, explain what was verified in the content, and use metadata for evidence rather than a second description.