Skip to content

add TL;DR version of this repo main description #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 1, 2021

Conversation

rizdaprasetya
Copy link
Contributor

@rizdaprasetya rizdaprasetya commented Nov 1, 2021

Preliminary checks

Summary

As a non native-English speaker (who got linked to this repo by someone with no prior context), at first I couldn't understand what is this repo about. I'm not even familiar with the term "Falsehood". Then I tried to read the main description, it also has few big-words that took time for me to understand too.

Then after finally I figured it out, I wonder:

  • Is there anyway this can be explained with more easy-to-digest word? Some kind of TLDR with example?

So here it is, I'm trying to add it, with this PR. The TLDR is hidden within <details> by default, so it is completely optional for people to read.

Please review, and merge if relevant. Thanks. If not, then it's fine by me too.

Preview

@rizdaprasetya rizdaprasetya changed the title add TL;DR version description add TL;DR version of this repo main description Nov 1, 2021
awesome linter don't like duplicate links, so to fix: the tldr example will just link to the #emails section
@kdeldycke
Copy link
Owner

You're absolutely right. I'm a non native-speaker too, and re-reading my intro, I find it to be a little bit fancy. Your proposal is short, to the point, and accurate.

Here is what I'll do: merge it right away, expose it out of the <details> tag, and move it up. I'll probably rework my description and move it below yours. Maybe remove mine entirely. What do you think?

Thanks a lot for this PR, it is a high quality improvement that adds a lot of readability! 🤩

@kdeldycke kdeldycke merged commit b5dcc80 into kdeldycke:main Nov 1, 2021
@kdeldycke kdeldycke added the ⚖️ curation Links or structure needs to be refined label Nov 1, 2021
kdeldycke added a commit that referenced this pull request Nov 1, 2021
Move fancier falsehood article description to contribution guide. Refs #105
@kdeldycke
Copy link
Owner

I just promoted your TL;DR as the canonical introduction of this list in c77087f

Thanks again @rizdaprasetya for this awesome contribution!

@github-actions
Copy link
Contributor

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 31, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
⚖️ curation Links or structure needs to be refined
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants