Skip to content

docs: show quoted heredocs for multi-line triage Reports - #1730

Merged
JacobStephens2 merged 1 commit into
mainfrom
issue-1728
Nov 4, 2026
Merged

JacobStephens2 merged 1 commit into
mainfrom
issue-1728

Conversation

@JacobStephens2

@JacobStephens2 JacobStephens2 commented Nov 4, 2026 •

Copy link
Copy Markdown
Owner

Summary

Document how to paste multi-line Reports into a Triage run and regenerate the published manual.

 Triage runs
+ thirdshift triage <<'EOF'
+ <pasted multi-line Report>
+ EOF
+ Explain literal apostrophes, dollar signs and backticks, and delimiter choice.

Closes #1728

Evidence

  • Before: the Triage runs examples showed a single-line printf pipe and --file, without a quoted heredoc for pasted Reports.
    After: the Markdown and generated manual show a multi-line quoted heredoc and explain why its contents stay literal. Executing the documented example in Bash with a stdin-capture stub preserved the Report byte for byte; decoding the HTML code block preserved the copyable command.
  • npm run docs:check --prefix site passed.
  • scripts/affected-tests main passed: npm test --prefix site (61 tests), cargo test --test share_card --test site_deploy, and cargo test --bin thirdshift prompts_page.

Merge Danger

Door: two-way

Blast Radius: documentation

Unaddressed findings

Standards

None. The review raised 0 findings.

Spec

None. The review raised 0 findings.

Security

None. The review raised 0 findings.

Security review outcome

No unaddressed introduced findings.

Review coverage

Both reviewers read the changed hunks in docs/guide.md and site/docs/index.html. No changed file was left unread; there were no generated-output exclusions.

Built with codex codex-cli 0.164.0 · gpt-6.1-sol · xhigh

@JacobStephens2
JacobStephens2 merged commit 95d2a3c into main Nov 4, 2026
4 checks passed
@JacobStephens2
JacobStephens2 deleted the issue-1728 branch November 4, 2026 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the quoted heredoc (<<'EOF') pattern for passing multi-line Reports to thirdshift triage

1 participant