Code Monkey home page Code Monkey logo

tldr's Introduction

Bitcoin TLDR

Bitcoin TLDR

Because someone should be reading it

This application presents summaries of the bitcoin-dev and lightning-dev mailing lists. We intend to add other sources like StackExchange in the future.

To run this locally

The statically generated content in this repo is extracted from mailing list summaries, which runs a nightly cron job to update the static xml files that we use as the data source. We employ a git submodule in the public folder to keep this material up to date. The easiest way to pull down everything is to run git clone --recurse-submodules rather than the standard git clone.

It's easy to build from there:

npm install
npm run dev

Open http://localhost:3000 with your browser and bask in the glow of tens of thousands of mailing list summaries at your fingertips.

tldr's People

Contributors

adamjonas avatar dependabot[bot] avatar emmanuel-develops avatar extheoisah avatar igbopharaoh avatar maheshchandra10 avatar nully0x avatar urvishp80 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

tldr's Issues

Styling Issue with banner and nav header

Current behavior: on scroll, the banner header covers the nav bar which makes it difficult to search without 1st closing the banner.

Expected behavior: The nav bar should be fixed at a height such that it remains below the banner. When the banner is closed, it should return to its original position.

image

punch list

  • Trailing comma when only 2 contributors
Screenshot 2023-07-31 at 11 45 54 AM

Add some modification to the daily summary paragraph

The daily summary paragraph need some updates in order to upgrade its clarity:

  • The text size is way too big compared to other texts on the website.
  • The used font is not coherent with the other fonts on the website.
  • The text is packed into one paragraph. It would be good to separate it into multiple paragraphs.

regressions and issues

  • the daily summary has markdown links but they are displayed in text and not links
Screenshot 2024-01-18 at 7 54 03 PM
  • the link from active discussions is to individual posts and not the combined summaries
Screenshot 2024-01-18 at 7 55 42 PM
  • the author breadcrumb links to the page you are already on. (I don't understand where it is supposed to point or why it is a link at all)
Screenshot 2024-01-18 at 7 56 50 PM
  • The replies link in the active discussions section points to the original post rather than the history section of the combined summary.

  • posts that have no replies are said to have 1 reply (all the other the counts seem to be increased by 1)

Screenshot 2024-01-18 at 7 58 18 PM

Add a documentation or faq page

Context: There is no documentation or faq page

Idea: Add a documentation or a faq page which the following topics, for example:

  • What is "TLDR"?
  • Where do come the displayed information?
  • How to access the mailing lists?
  • How to contribute?
  • ...

Email digest

Subscribe to a daily or weekly email digest

(This is probably a backend job)

Discussion history not complete

While going the checklist for tldr, I noticed the discussion history for the third summary in Today in Bitcoin/Lightning History section was not complete. The number of replies is 5 while the discussion history is just 3.

I've checked the json file and the reply count and author is correct, so I think it might be something concerning the way we are generating history links or null data is being returned as a response.

Screenshot 2024-04-12 at 09 37 41 Screenshot 2024-04-12 at 09 38 08

Modify the slider behavior on phone

Context: When visiting the website on a phone, there is no possibility to drag the slider in order to scroll faster to the bottom.

Idea: Allow the user to drag the slider in order to move faster on the website.

IMG_20231101_160014

Add some separator between sections

Context: When visiting the website, we can see a lot information and an uninformed user could miss some discussions on the way due to the fact that there are not clearly separated, even if they are well organised.

Idea: Add separators between discussions or add a shadow under each section (or each 2 sections).

Screenshot from 2023-11-01 15-22-40

Punch list

Newsletter page summary needs paragraph spacing

Sources and number of replies need to be added to newsletter summaries

Monthly summaries at bottom of the newsletter pages should be titled at dates not descriptions

image
Footer in dark mode is messed up

Delving needs it's own icon

Add a link to the "Replies" buttons

The replies buttons on the homepage are currently displaying the number of replies of the showed discussion.

The idea is to add a link that will redirect the user to the first item of the "Discussion history", inside the discussion's link.

Ex : https://tldr.bitcoinsearch.xyz/summary/bitcoin-dev/Oct_2023/combined_Full-Disclosure-CVE-2023-40231-CVE-2023-40232-CVE-2023-40233-CVE-2023-40234-All-your-mempool-are-belong-to-us-
Screenshot from 2023-11-01 15-00-01

By clicking the "63 replies", the user should be redirected here:
Screenshot from 2023-11-01 15-02-11

Author pages

See all posts by an author.

(Should be done on the backend.)

Add a description for the website

Add a description for the website for more clarity for users.
It can be located between the "TLDR" and "Your daily summary" titles.

You can put the same description that is on this repo readme: "presents summaries of the bitcoin-dev and lightning-dev mailing lists. We intend to add other sources like StackExchange in the future."

Screenshot from 2023-11-01 14-51-18

Make it easy for me as a user to understand where an individual email summary lives in the context of the broader thread

Right now, if a user lands on an individual mail summary, it's hard to figure out where it lives in the context of the broader thread (if at all).

So, if a user lands, say, here, there should be some way to go up in the information architecture to the broader thread summary. Or to know that this reply is part of a broader thread and not standalone.
image

A few ideas (red box for emphasis)

  1. Simple link with the same phrasing on all individual emails
    image

  2. Breadcrumb, which will require more work and could be interesting to help user navigate if/ when we get more sources to draw from
    image

The search box shouldn't move when querying it

Context: There is this weird behavior where, when scrolling and suddenly wanting to do a search, clicking on the search button will take you to the top of the homepage.

Could the user do a search without being taken back to the top of the page?

tldr_search.webm

Modify the "Search" box behavior

Context: Currently, when we click in the "Search" box, it opens pop up where the search is done, with some filters.

Idea: Allow the searching directly in the "Search" box and add the filters (the ones displayed in the pop up) in it.

Screenshot from 2023-11-01 15-12-23

inconsistency of text display of combined summaries

This is the combined summary of for the hot topics:

Screenshot 2023-10-13 at 12 51 31 PM

and this is in the all activity:

Screenshot 2023-10-13 at 12 51 40 PM

I'd prefer the top layout for the all activity feed which includes the original author and the other involved in the thread, but at the least we should have the same author (the bottom one show the latest author I believe).

Add information about how datas are used

Context: Visitors have no information on which of their data are collected on for which purpose.

Idea: Add a banner or a dedicated page in which the following information will appear:

  • Which data are collected?
  • For what purpose(s)?
  • How many time will the data be kept?
  • How to access them?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.