Skip to content

docs(debug-journal): say what belongs in the journal and search similar issues in triage - #5350

Merged
springfall2008 merged 1 commit into
mainfrom
docs/debug-journal-scope
Oct 2, 2026
Merged

springfall2008 merged 1 commit into
mainfrom
docs/debug-journal-scope

Conversation

@chalfontchubby

Copy link
Copy Markdown
Collaborator

Opened by Claude on behalf of @chalfontchubby.

What this does

Writes down what the debug journal is for, after Trefor's steer on 2 Oct 2026 that it should stay a memory of what debugging learnt, that past findings are useful but go stale easily, and that the triage skill should also look at similar earlier issues.

  • tools/debug-journal.md: new "What belongs here" section. Keep techniques and traps, one-line durable device or API facts, and short dated findings that explain a class of report. Leave per-issue narrative (what was tried, the fix, rejected alternatives) to the PR and issue. Retire an entry when the code it describes changes.
  • journal-update skill: same rule, so the daily fold-in drops narrative and cuts shipped-fix rows down to "fixed in PR #N".
  • JOURNAL_CAPTURE_PROMPT (tools/triage_daemon.py): one sentence asking runs to leave out the ticket's own story when queueing a finding.
  • issue-triage skill, step 4: besides duplicates, search open and closed issues and PRs for similar ones, read what they found, and link them as related. Call something a duplicate only when the cause matches, not just the symptom.

Why

#5344 was closed as a duplicate of #5330 on a matching symptom. A closer look showed it shares a trigger with #5343 and is not the same problem, so it was reopened. Searching for similar issues first, and being strict about what counts as a duplicate, is aimed at that.

Not in this PR

Compacting the existing journal against the new rule. That is a larger change and will be its own PR.

Testing

./run_pre_commit passes. tools/test_triage_daemon.py passes (308 tests) when run from tools/.

🤖 Generated with Claude Code

…o read similar issues

Following Trefor's steer on 2 Oct 2026: keep techniques and traps, one-line
device or API facts and short dated findings that explain a class of report;
leave per-issue narrative to the PR and issue; retire entries when the code
they describe changes. The journal-update skill and the daemon's capture
prompt carry the same rule, and the triage skill now searches for similar
issues and PRs (not only duplicates) and links them as related.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@chalfontchubby chalfontchubby added the documentation Improvements or additions to documentation label Oct 2, 2026
@springfall2008
springfall2008 merged commit b161949 into main Oct 2, 2026
2 checks passed
@springfall2008
springfall2008 deleted the docs/debug-journal-scope branch October 2, 2026 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants