Skip to content

Fold in round-2 public-readiness nice-to-haves - #84

Merged
dmccoystephenson merged 1 commit into
mainfrom
fix/readiness-round2-followups
Aug 3, 2026
Merged

Fold in round-2 public-readiness nice-to-haves#84
dmccoystephenson merged 1 commit into
mainfrom
fix/readiness-round2-followups

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

Addresses the remaining actionable nice-to-haves from the round-2 public-readiness re-review (post-merge of #82), plus a large stale-branch cleanup.

  • .github/ISSUE_TEMPLATE/config.yml: adds a contact_links entry pointing would-be vulnerability reporters at SECURITY.md instead of a public issue — surfaced directly in GitHub's "new issue" picker rather than requiring a reporter to read past the bug-report template first.
  • CLAUDE.md: adds a doc-sources-of-truth row for the top-level SECURITY.md added in Add top-level SECURITY.md #82 — every other doc file was already tracked for drift, this one wasn't.
  • docs/USAGE.md: drops the last unnamed "a separate local project" reference that survived Add top-level SECURITY.md #82's "elsewhere in this ecosystem" cleanup — the sentence is now self-contained.
  • docs/ALERTING.md: splits a run-on sentence (embed shape + color mapping mashed into one clause) into two.

Also deletes 25 stale branches — 24 confirmed MERGED via gh pr list --state all --head <branch>, plus feature/transcript-visibility (no PR record, but confirmed fully merged via ancestor check — zero commits ahead of main). One additional stale branch, fix/cli-repo-validation-and-dashboard-batch-progress, was deliberately left alone — it has 3 commits not reachable from main, i.e. real unmerged work, not safe to delete without your call on it.

Not included, with reasons:

  • docs/OVERNIGHT.md's hardcoded /root/.local/bin PATH export, flagged in the review as low-priority/genericizable: on closer look this is a verbatim copy of the real, currently-deployed bin/run-overnight.sh (CLAUDE.md's doc-sources table requires the two match verbatim), and that script's own comment block explains the hardcoding is deliberate — Task Scheduler's minimal-env WSL launch needs an explicit path, and depending on $HOME was exactly the failure mode the script was written to route around. Changing the doc without changing (and re-verifying, live) the real nightly-scheduled script would just create drift against a documented invariant, and I'm not touching production automation blind. Left as-is.
  • Issue Git history + stale branches mention Stephenson-Software/gateway by name (no secrets found — not blocking) #77 (gateway naming in git history): unchanged — a git-history rewrite is a separate, deliberate call the review already flagged as not fitting a docs PR.

Test plan

  • /root/.venvs/gardener/bin/python3 -m unittest discover -s tests — 553 tests pass, OK.
  • Validated config.yml parses as YAML (python3 -c "import yaml; yaml.safe_load(...)").
  • Verified all 24 branches with a PR record showed MERGED, and confirmed feature/transcript-visibility has zero commits ahead of main before deleting it.
  • Confirmed fix/cli-repo-validation-and-dashboard-batch-progress has 3 commits not in main before deciding to leave it.

🤖 Generated with Claude Code

…able row, wording cleanup

- .github/ISSUE_TEMPLATE/config.yml: add a contact_links entry pointing
  would-be vulnerability reporters at SECURITY.md instead of a public
  issue, surfaced directly in GitHub's "new issue" picker.
- CLAUDE.md: add a doc-sources-of-truth row for the top-level SECURITY.md
  added in #82 — every other doc file was already tracked for drift.
- docs/USAGE.md: drop the last unnamed "a separate local project"
  reference that survived #82's aside cleanup; the sentence is now
  self-contained without pointing at unnamed prior art.
- docs/ALERTING.md: split the run-on Discord-embed-shape sentence into
  two, separating the shape claim from the color-mapping claim.

Not included, with reasons:
- docs/OVERNIGHT.md's hardcoded `/root/.local/bin` PATH export in the
  bin/run-overnight.sh example: this is a verbatim copy of the real,
  currently-deployed script (CLAUDE.md's doc-sources table requires the
  two to match verbatim), and the script's own extensive comment block
  explains the hardcoding is deliberate -- Task Scheduler's minimal-env
  WSL launch needs an explicit path, and depending on $HOME instead was
  exactly the failure mode this script was written to route around.
  Genericizing the doc without changing (and re-verifying) the real
  script would create doc/script drift against a documented invariant,
  and changing the real nightly-scheduled script isn't something to do
  blind. Left alone.
- Issue #77 (gateway naming in git history): unchanged -- rewriting
  published history is a separate, deliberate call, not a docs PR.

Also deletes 24 stale, already-merged branches (confirmed via `gh pr
list --state all --head <branch>`, or by ancestor check for one with no
PR record). One additional stale branch,
fix/cli-repo-validation-and-dashboard-batch-progress, was left alone --
it has 3 commits not reachable from main, i.e. real unmerged work, not
safe to delete without a maintainer decision.
@dmccoystephenson
dmccoystephenson merged commit 27f3a05 into main Aug 3, 2026
2 checks passed
dmccoystephenson added a commit that referenced this pull request Aug 3, 2026
…able row, wording cleanup (#84)

- .github/ISSUE_TEMPLATE/config.yml: add a contact_links entry pointing
  would-be vulnerability reporters at SECURITY.md instead of a public
  issue, surfaced directly in GitHub's "new issue" picker.
- CLAUDE.md: add a doc-sources-of-truth row for the top-level SECURITY.md
  added in #82 — every other doc file was already tracked for drift.
- docs/USAGE.md: drop the last unnamed "a separate local project"
  reference that survived #82's aside cleanup; the sentence is now
  self-contained without pointing at unnamed prior art.
- docs/ALERTING.md: split the run-on Discord-embed-shape sentence into
  two, separating the shape claim from the color-mapping claim.

Not included, with reasons:
- docs/OVERNIGHT.md's hardcoded `/root/.local/bin` PATH export in the
  bin/run-overnight.sh example: this is a verbatim copy of the real,
  currently-deployed script (CLAUDE.md's doc-sources table requires the
  two to match verbatim), and the script's own extensive comment block
  explains the hardcoding is deliberate -- Task Scheduler's minimal-env
  WSL launch needs an explicit path, and depending on $HOME instead was
  exactly the failure mode this script was written to route around.
  Genericizing the doc without changing (and re-verifying) the real
  script would create doc/script drift against a documented invariant,
  and changing the real nightly-scheduled script isn't something to do
  blind. Left alone.
- Issue #77 (a-private-repo naming in git history): unchanged -- rewriting
  published history is a separate, deliberate call, not a docs PR.

Also deletes 24 stale, already-merged branches (confirmed via `gh pr
list --state all --head <branch>`, or by ancestor check for one with no
PR record). One additional stale branch,
fix/cli-repo-validation-and-dashboard-batch-progress, was left alone --
it has 3 commits not reachable from main, i.e. real unmerged work, not
safe to delete without a maintainer decision.
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.

1 participant