search

bitcoinsearch / summarizer

Generation of easily accessible summarization feeds for public consumption
MIT License
5 stars 5 forks source link

Enhance documentation #53

Closed kouloumos closed 6 months ago

kouloumos commented 7 months ago

Refined project documentation and added comments during an in-depth review to map out the project's architecture and component interactions.

@urvishp80 I would appreciate if you can review and verify that my attempt to explain the flow and what each script does is correct. Also, I prefixed a few comments with @?, those are questions that I have and I thought that it would be easier to discuss/answer them in-line. I will delete them (or transform them to @TODO) before merging this.

The cron-jobs are also documented on the sequence diagram that I created for Bitcoin Search & friends. I would also appreciate a review of that one.

kouloumos commented 6 months ago

@urvishp80 I rebased and converted my observations to TODOs

During rebase, I also modified a comment based on my observation here.