docs: document the sourcing gate and the send skip report - #11
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 ledgerlooks like an error when it's actually the duplicate-send guard doing its job.What changed
sourceand 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.run. It now covers all three stages:sourcereports already-known companies,runnames anything it can't reach,sendreports each skipped note with a reason.Repo description
Updated alongside this (settings, not the tree) to mention the sourcing gate and that this is a personal project built in public:
Verified
pytest -q→ 607 passed (unchanged; docs only).fb_signal,prospector dm, or the deletedCONTRIBUTING.md.🤖 Generated with Claude Code