Skip to content

docs: document the sourcing gate and the send skip report - #11

Merged
anusbutt merged 2 commits into
mainfrom
docs/reflect-recent-changes
Aug 14, 2026
Merged

docs: document the sourcing gate and the send skip report#11
anusbutt merged 2 commits into
mainfrom
docs/reflect-recent-changes

Conversation

@anusbutt

Copy link
Copy Markdown
Owner

Follow-up to #9 and #10, both of which merged before this landed. Documentation only — no code changes.

The README was describing behavior two changes out of date. Most notably, the send skip report from #9 shipped with no documentation at all, and it's the output most likely to be misread: already in ledger looks like an error when it's actually the duplicate-send guard doing its job.

What changed

  • Capabilities — sourcing returns only companies not already in the vault; every stage explains what it left out.
  • Flow diagram — now starts at source and shows the email-recovery step. Both were missing, so the diagram implied you always bring your own list and that a row without an address is simply lost.
  • Safety guarantees — the "no company is silently dropped" row covered only run. It now covers all three stages: source reports already-known companies, run names anything it can't reach, send reports each skipped note with a reason.
  • Send section — adds the skip report with a worked example and the common reasons.
  • Review workflow — notes that an approved note is not necessarily a sendable one. That assumption is exactly what made the skip output confusing in practice.

Repo description

Updated alongside this (settings, not the tree) to mention the sourcing gate and that this is a personal project built in public:

Python CLI that researches local service businesses on the open web and drafts evidence-cited cold outreach into an Obsidian vault — then sends only what a human approves. Sourcing skips companies you already have. Email only; the offer is a swappable per-vertical profile. Never contacts Facebook. Personal project, built in public.

Verified

  • pytest -q → 607 passed (unchanged; docs only).
  • All README table-of-contents anchors resolve.
  • Swept for stale claims — no remaining references to Messenger, fb_signal, prospector dm, or the deleted CONTRIBUTING.md.

🤖 Generated with Claude Code

anusbutt and others added 2 commits July 27, 2026 15:11
README was describing behavior two changes out of date.

- Capabilities now mention that sourcing returns only companies not already in
  the vault, and that every stage explains what it left out.
- The flow diagram starts at `source` and shows email recovery, both of which
  were missing.
- The safety-guarantee row "no company is silently dropped" now covers all three
  stages rather than only `run`: source reports already-known companies, run
  names anything it cannot reach, send reports each skipped note with a reason.
- The send section shows the skip report with a worked example and lists the
  common reasons. This shipped without documentation, and "already in ledger" in
  particular reads as an error when it is the duplicate-send guard working.
- The review workflow notes that an approved note is not necessarily a sendable
  one, which is the assumption that made the skip output confusing.

Repo description updated to mention the sourcing gate and that this is a
personal project built in public.
@anusbutt
anusbutt merged commit 9136288 into main Aug 14, 2026
2 checks passed
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