Remove misplaced intro text in /doc + minor fixes #14787

pull merland wants to merge 1 commits into bitcoin:master from merland:issue14639 changing 2 files +3 −25
  1. merland commented at 8:03 PM on November 22, 2018: contributor

    As outlined in issue #14639, there are some old and redundant 'running' instructions in two READMEs in /doc. This PR fixes that by instead linking to the official docs about running a node.

    Also, changed the download link to point to the download page instead of the releases page.

    This is a near-duplicate of PR14755 that was closed (maybe prematurely). Please see that PR for some discussion.

  2. fanquake added the label Docs on Nov 22, 2018
  3. DrahtBot commented at 11:25 PM on November 22, 2018: member

    <!--e57a25ab6845829454e8d69fc972939a-->

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

    <!--174a7506f384e20aa4161008e828411d-->

    Conflicts

    No conflicts as of last run.

  4. laanwj commented at 7:59 AM on November 23, 2018: member

    Tend to NACK. I prefer having this documentation self-contained and not refer to bitcoin.org. Yes, mentioning the full-node guide might be useful, but it shouldn't be the sole source of information.

  5. merland force-pushed on Nov 23, 2018
  6. merland commented at 8:51 AM on November 23, 2018: contributor

    @laanwj Thanks for reviewing, good to finally get some comments about this :) It sounds reasonable to keep some minimal self-contained documentation, I updated the commit.

    There is also the question about some of text being misplaced. Phrases like "Bitcoin is a free open source peer-to-peer electronic cash system..." and "Bitcoin Core is the original Bitcoin client..." seem to be misplaced at this level in the tree. I think they are an heritage from before QT was merged upstream. These intro/setup texts are still removed in the updated commit.

    After this, README_windows.txt contains only duplication, but removal causes Gitian build failure. This should be adressed but maybe in another PR.

    Please re-review.

  7. laanwj commented at 9:25 AM on November 23, 2018: member

    There is also the question about some of text being misplaced. Phrases like "Bitcoin is a free open source peer-to-peer electronic cash system..." and "Bitcoin Core is the original Bitcoin client..."

    I agree about that! The project description belongs in the top-level README.md, not there.

    In any case especially README_windows.txt is meant for people that have shortly ago downloaded the binaries, they probably already know what bitcoin is.

  8. laanwj commented at 9:28 AM on November 23, 2018: member

    The contradictory thing about doc/README.md is that it serves two functions:

    • it lists the other documentation in doc/ (as github displays this text when browsing to the directory)
    • it's copied to the archive to serve as introduction text

    These functions are incompatible, and I think a lot of recent changes to these files are based on different ideas of what should be in there, but the real solution would be to split it up.

  9. merland renamed this:
    Replace old instructions with links to official docs
    Remove misplaced intro text in /doc + minor fixes
    on Nov 23, 2018
  10. in doc/README.md:12 in a24d689c22 outdated
       9 | +To download Bitcoin Core, visit [bitcoincore.org](https://bitcoincore.org/en/download/).
      10 |  
      11 |  Running
      12 |  ---------------------
      13 | -The following are some helpful notes on how to run Bitcoin Core on your native platform.
      14 | +The following are some helpful notes on how to run Bitcoin Core on your native platform. (For further details, please refer to https://bitcoin.org/en/full-node)
    


    practicalswift commented at 1:29 PM on November 23, 2018:

    Surround the URL by angle brackets to make sure it is converted to a link by all markdown parsers :-)


    merland commented at 9:10 AM on November 25, 2018:

    Thanks, I updated the commit.

  11. merland force-pushed on Nov 25, 2018
  12. merland force-pushed on Nov 25, 2018
  13. Remove misplaced intro text, link to full node docs, fix download link 76deb347eb
  14. merland force-pushed on Nov 25, 2018
  15. merland commented at 6:36 PM on November 26, 2018: contributor

    @laanwj I agree about the contradiction. I will try to look into that and hopefully submit another PR. Regarding this one, have you had a chance to look at the the latest version? Or anyone, of course.

  16. laanwj referenced this in commit c7fab5571d on Jan 9, 2019
  17. merland commented at 9:27 PM on January 9, 2019: contributor

    Closing. The download link was fixed in #15128 and the rest was controversial.

  18. merland closed this on Jan 9, 2019

  19. merland deleted the branch on Apr 15, 2019
  20. DrahtBot locked this on Dec 16, 2021

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-17 06:15 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me