Goal
Replace every !!! warning "Example needed" placeholder on every CLI doc page with live, redacted input/output examples (pretty + JSON + YAML where applicable).
Why
Project rule: every command must show a real input and a real output. Currently only 7 pages site-wide satisfy this. The 4 DLP pages flagged most recently (dictionaries, filtering-profiles, patterns, profiles) are part of a wider gap that spans nearly every page under docs/cli/runtime/, docs/cli/redteam/, and docs/cli/model-security/.
Scope
All docs/cli/runtime/*, docs/cli/runtime/dlp/*, docs/cli/redteam/*, and docs/cli/model-security/* pages that contain the Example needed placeholder.
Approach
- Spec:
docs/superpowers/specs/2026-05-25-cli-docs-examples-design.md
- Plan:
docs/superpowers/plans/2026-05-25-cli-docs-examples.md
- 13 sub-issues, end-to-end per command group. PREP issue blocks the rest; others parallelize across 3 tmux agents.
Format contract
- List/get commands → pretty + JSON + YAML captures
- Write ops (create/update/replace/patch/delete) → JSON only
- Upstream/CLI/SDK defects →
!!! bug admonition with tracking-issue link (never fabricate output)
- Redaction: tenant IDs, UUIDs, real emails, real customer app names, sensitive keyword content
Sub-issues
(populated after creation; see sub-issues panel)
Definition of done
- All 13 sub-issue PRs merged.
grep -r "Example needed" docs/cli/ returns nothing (or only justified !!! bug placeholders).
- Every newly-discovered CLI/SDK/upstream defect filed as its own issue with
bug or upstream-bug label.
Goal
Replace every
!!! warning "Example needed"placeholder on every CLI doc page with live, redacted input/output examples (pretty + JSON + YAML where applicable).Why
Project rule: every command must show a real input and a real output. Currently only 7 pages site-wide satisfy this. The 4 DLP pages flagged most recently (
dictionaries,filtering-profiles,patterns,profiles) are part of a wider gap that spans nearly every page underdocs/cli/runtime/,docs/cli/redteam/, anddocs/cli/model-security/.Scope
All
docs/cli/runtime/*,docs/cli/runtime/dlp/*,docs/cli/redteam/*, anddocs/cli/model-security/*pages that contain theExample neededplaceholder.Approach
docs/superpowers/specs/2026-05-25-cli-docs-examples-design.mddocs/superpowers/plans/2026-05-25-cli-docs-examples.mdFormat contract
!!! bugadmonition with tracking-issue link (never fabricate output)Sub-issues
(populated after creation; see sub-issues panel)
Definition of done
grep -r "Example needed" docs/cli/returns nothing (or only justified!!! bugplaceholders).bugorupstream-buglabel.