Hi,
I feel like naming the example algorithm whats-alf can be confusing as well as the following part of the readme:
1. Implement indexing logic in `src/subscription.ts`.
This will subscribe to the repo subscription stream on startup, parse events and index them according to your provided logic.
2. Implement feed generation logic in `src/algos`
For inspiration, we've provided a very simple feed algorithm (`whats-alf`) that returns all posts related to the titular character of the TV show ALF.
When you look at it, it's actually an algorithm that show the latest posts. The logic that filters ALF related posts is actually living in the subscription, when messages are indexed.
This makes sense because for simple feeds, you'll probably want to index as little as possible, so most of the filtering will happen there.
The change I would propose would be:
renamed the algorithm whats-alf to latest
explaining that the subscription is a first level of filtering to get the post that have great chances to be relevant, and that optionally a second level of finer-grained filtering can be implemented in the algorithm
Hi, I feel like naming the example algorithm
whats-alfcan be confusing as well as the following part of the readme:When you look at it, it's actually an algorithm that show the latest posts. The logic that filters ALF related posts is actually living in the subscription, when messages are indexed.
This makes sense because for simple feeds, you'll probably want to index as little as possible, so most of the filtering will happen there.
The change I would propose would be:
whats-alftolatestWhat do you think?