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

Readme: added links for acronyms #380

Merged
merged 2 commits into from Oct 10, 2018

Conversation

Projects
None yet
3 participants
@uniconstructor
Copy link
Contributor

uniconstructor commented Oct 9, 2018

Readme is the first document visible when you open a github repo.
I think some acronyms need to be linked to their official project websites (if you never heard about them).
For example:

  1. APM: what is is? Atom Package Manager or Aragon Package Manager? (OK, I know that APM is about Aragon here - but first links in search results will lead you to Atom repo. It's confusing)
  2. IPFS is another JAFA for any person who never heard about this amazing technology. Let's tell everyone about it.
  3. ENS confuses even me. What does it stands for? I never worked with blockchain name systems. When I try to search "ENS" I found this: https://ens.domains/
    Is it an official site for Ethereum Name System technology?
    (Is ENS is about Ethereum Name System here in the first place?)
    I am not sure about ENS, because official ethereum site has 0 results for "ENS" (seriously - try page search {space}ENS{space} - no results. Why?)
    I am don't want to link people to wrong URL - so can you provide a link to the official Ethereum Name System project website or protocol description?
Readme: added links for acronyms
Readme is the first document visible when you open a github repo.
I think some acronyms need to be linked to their official project websites (if you never heard about them).
For example:
1) APM: what is is? [Atom Package Manager](https://github.com/atom/apm) or [Aragon Package Manager](https://hack.aragon.org/docs/apm.html)? (OK, I know that APM is about Aragon here - but first links in search results will lead you to Atom repo. It's confusing)
2) IPFS is another JAFA for any person who never heard about this amazing technology. Let's tell everyone about it.
3) ENS confuses even me. What does it stands for? I never worked with blockchain name systems. When I try to search "ENS" I found this: https://ens.domains/
Is it an official site for Ethereum Name System technology?
(Is ENS is about Ethereum Name System here in the first place?)
I am not sure about ENS, because [official ethereum site](https://www.ethereum.org/) has 0 results for "ENS" (seriously - try page search {space}ENS{space} - no results. Why?)
I am don't want to link people to wrong URL - so can you provide a link to the official Ethereum Name System project website or protocol description?
@CLAassistant

This comment has been minimized.

Copy link

CLAassistant commented Oct 9, 2018

CLA assistant check
All committers have signed the CLA.

@sohkai

sohkai approved these changes Oct 10, 2018

Copy link
Member

sohkai left a comment

Awesome, thanks @uniconstructor!

@sohkai sohkai merged commit 519e598 into aragon:master Oct 10, 2018

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
license/cla Contributor License Agreement is signed.
Details

@uniconstructor uniconstructor deleted the uniconstructor:patch-1 branch Oct 10, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment