Relationships
#2407 Docs: manual does not document issue submission redaction or --no-redact
Opened by skunk-ape · 9/23/2026
Gap
The manual documents neither the automatic redaction applied to issue
submissions nor the --no-redact opt-out flag.
content/manual/reference/issue-commands.md lists the flags for swamp issue bug, feature, security, edit and ripple without mentioning that title
and body are redacted by default, and without listing --no-redact at all —
the flag exists on all five subcommands.
content/manual/how-to/file-issues-from-the-cli.md does not mention it either.
Why it matters
Redaction is a security control users depend on, and it runs by default on every submission path. Because it is undocumented:
- Users do not know a safety net exists, so they do not know to check the redaction notice printed before submission.
- Users who deliberately sanitized their content have no documented way to
discover
--no-redact. - When redaction misbehaves — either passing a secret through or over-redacting diagnostic content — users have no documented baseline to compare against.
This surfaced while fixing swamp-club lab issue 1702, where label-prefixed secrets passed through the redactor unredacted. The redactor gave a false sense of safety, and nothing in the manual describes what it does or does not cover.
Suggested content
In reference/issue-commands.md:
- Add
--no-redactto the flag table forbug,feature,security,editandripple. - Add a short section stating that title and body are scanned and redacted before submission on every path, including email submission, that a summary of what was redacted is printed before sending, and that placeholders are stable within a submission so the same value maps to the same placeholder.
In how-to/file-issues-from-the-cli.md:
- A short note that redaction happens automatically, what categories are covered (secrets, credentials, addresses, hostnames, home directory paths, personal identifiers), and that the printed notice should be reviewed before the report is sent.
Worth stating plainly that redaction is a best-effort safety net, not a guarantee, so users still review what they paste.
Closed
No activity in this phase yet.
stack72 commented 9/23/2026, 10:33:18 PM
Fixed in https://github.com/swamp-club/swamp-club/pull/1247 — issue-commands.md adds --no-redact to bug, feature, security, edit and ripple, plus a Redaction section (categories, stable placeholders, the printed notice, best-effort caveat). file-issues-from-the-cli.md gains a 'Check what was redacted' step.
Sign in to post a ripple.