doc: Rework internal and external links #21210

pull MarcoFalke wants to merge 1 commits into bitcoin:master from MarcoFalke:2102-docLinks changing 1 files +7 −6

MarcoFalke commented at 8:33 AM on February 17, 2021: member
Some minor changes:
- Move Bitcoin Core download link to the very top. Reason: The download link has nothing to do with the section that explains Bitcoin. Also, anyone quickly looking for the download link will find it faster.
- Add a new link to the doc folder. Reason: Apart from the documentation that is shipped with the binary software, the doc folder is the primary location for Bitcoin Core related documentation.
- Remove dead link to pdf. Reason: The pdf can be trivially found by asking a search engine.
- Remove reference to "build server". Reason: There is no "build server". The CI system is explained in the next sentence in detail.
- Remove dead? link to translation mailing list. Reason: The translation process is explained in doc/translation_process.md, no need to explain it in detail in the main readme.
doc: Rework internal and external links 77772a1b80
fanquake added the label Docs on Feb 17, 2021
in README.md:20 in 77772a1b80
```
  16 | @@ -12,9 +17,7 @@ with no central authority: managing transactions and issuing money are carried
  17 |  out collectively by the network. Bitcoin Core is the name of open source
  18 |  software which enables the use of this currency.
  19 |  
  20 | -For more information, as well as an immediately usable, binary version of
  21 | -the Bitcoin Core software, see https://bitcoincore.org/en/download/, or read the
  22 | -[original whitepaper](https://bitcoincore.org/bitcoin.pdf).
  23 | +For more information read the original Bitcoin whitepaper.
```
flack commented at 9:39 AM on February 17, 2021:

isn't that a bit flimsy? It's not so hard to game Google rankings (and you can always buy ads, too), so googling "original Bitcoin whitepaper" could really give you anything. At least a footnote or something with bibliographic information (such as it is) would be nice, or maybe a md5sum of the "real" whitepaper, if that is feasible

theStack commented at 10:07 PM on February 17, 2021:

Crazy idea: what about adding instructions (or a script) on how to fetch the whitepaper directly from the UTXO set, as described e.g. by jb55 in https://bitcoinhackers.org/@jb55/105595146491662406 ("eat your own dogfood" ;-))

laanwj commented at 1:18 PM on February 18, 2021:

or maybe a md5sum of the "real" whitepaper, if that is feasible

Inb4 content-addressed storage (e.g. IPFS).

In any case, something like that could be added later, let's remove the broken link.

MarcoFalke commented at 1:26 PM on February 18, 2021:

Maybe there could be an extensive stack exchange question or documentation file that explains where and how to get the whitepaper and how to check it against a hashsum? If needed we could link to that. Though, I think this can be done in a follow-up. And if your search engine was bought to redirect the traffic, you might not find this repo in the first place ;)

laanwj commented at 1:35 PM on February 18, 2021:

Apparently it is actually on IPFS. gateway link here Users of some browsers like Brave can use the IPFS link directly and don't need the gateway.

michaelfolkson commented at 1:42 PM on February 18, 2021:

Would this suffice as the Stack Exchange question to link to? https://bitcoin.stackexchange.com/questions/35959/how-is-the-whitepaper-decoded-from-the-blockchain-tx-with-1000x-m-of-n-multisi

laanwj commented at 9:46 AM on February 19, 2021:

@michaelfolkson sort of ! unfortunately it uses the blocktrail API instead of bitcoin core RPC, i prefer that if we send people on a puzzle to get it, they'd at least learn to use our APIs along the way :smile:

(maybe a matter of adding an answer, though)

MarcoFalke commented at 10:15 AM on February 19, 2021:

There's a comment on how to do it with a pruned node, using the RPC: https://bitcoin.stackexchange.com/questions/35959/how-is-the-whitepaper-decoded-from-the-blockchain-tx-with-1000x-m-of-n-multisi#comment115247_101707
DrahtBot commented at 10:20 AM on February 17, 2021: member


The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.



Conflicts

Reviewers, this pull request conflicts with the following ones:
- #20976 (doc: fix broken link to whitepaper in README by ben-kaufman)
If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.
laanwj commented at 1:15 PM on February 18, 2021: member

ACK 77772a1b809e443a6861ee49009ff8bc55cff9c3

Remove dead? link to translation mailing list. Reason: The translation process is explained in doc/translation_process.md, no need to explain it in detail in the main readme.

Good find. I can't even remember anymore when we used that list.
RiccardoMasutti approved
RiccardoMasutti commented at 12:42 AM on February 19, 2021: contributor

ACK 77772a1
laanwj merged this on Feb 19, 2021
laanwj closed this on Feb 19, 2021
MarcoFalke deleted the branch on Feb 19, 2021
sidhujag referenced this in commit 9b4f624f0e on Feb 19, 2021
fanquake locked this on Feb 21, 2021