Repository navigation
docs: architecture/sequence/module diagrams, real CLI screenshots, badges, CI - #6
Merged
Merged
Conversation
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.
Summary
docs/ARCHITECTURE.md— data-flow diagram (including theneeds_reviewdead-end path), a full pipeline sequence diagram, a components table, a module-dependency diagram, and the reasoning behind every key design decision (confidence gate, field-level authority, true dry-run safety, department-priority ranking, per-project leads, the overwrite gate, sandbox-first vendors, naive UTC)docs/ADDING_A_VENDOR.md— how to wire in a real search vendor, contact-enrichment vendor, or CRM, mirroring each interface's existing template/real-client pattern.github/workflows/tests.yml— CI running the 46-test suite on push/PR tomain(mirrors the siblingtender-tracking-systemrepo's own workflow). No scheduled daily-run workflow yet — deliberately skipped since there's no real vendor wired in yet, so a scheduled run would only touch sandbox datascripts/generate_readme_assets.py— regenerates real CLI-output SVGs (not mockups) by running the actual CLI against a throwaway temp DBTest plan
pytest— 46 tests still passing after the README/docs changes (no code changes in this PR)scripts/generate_readme_assets.pyfor real — verified all 4 SVGs were written with real content (not empty/broken), and that the underlying CLI output matches what's documented (2 of 5 sample orgs resolve at high confidence, the aggregator false-positive is correctly excluded leaving a low-confidence single-source match,push-crmdry-run correctly shows the pre-seeded org reused via dedup)🤖 Generated with Claude Code