Repository navigation
docs(readme): simplify the How-it-works diagram to the shipped pipeline - #187
Merged
Merged
Conversation
Replace the 20-node graph (eleven sources, six of them dotted 'planned', plus a dangling 'email / Slack (planned)' output) with a seven-node top-down flow that shows only what ships: sources -> feed -> watch -> semantic_filter, with the LLM, delivery (instant or digest), and the drop path as the three exits. The roadmap sources stay listed in the Roadmap section, where they already were.
joshpanka
force-pushed
the
docs/how-it-works-diagram
branch
from
October 14, 2026 14:18
4a6fee0 to
922a856
Compare
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
1 participant
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.
The How-it-works diagram in the README had grown to 20 nodes across three subgraphs: eleven sources (six of them dotted "planned" edges), a separate out-group, and a dangling "email / Slack (planned)" node. Most of the ink went to things that don't exist yet, and the shipped path was hard to follow.
This replaces it with a seven-node top-down flow that shows only what ships today:
sources -> feed -> watch -> semantic_filter, then three exits: the LLM it judges with, delivery (webhook / log, instant or digest), and the drop path for items below threshold.
The five shipped sources sit in one node with one edge. The roadmap sources stay where they already were, in the Roadmap section a couple of headings down. Top-down rather than left-to-right so it still reads on a phone.
Rendered with mermaid-cli to check the layout before opening this.