Docs: reflow the text and add better markup #11759

pull jsarenik wants to merge 4 commits into bitcoin:master from jsarenik:jasan/little_text_fixes changing 4 files +245 −194
  1. jsarenik commented at 3:37 PM on November 23, 2017: none

    Here are some very uninportant fixes that just make the modified files look a bit more professional (one in rendered output, the other in terminal as plain-text).

    No changes to the text were done here. Just markup (monospace, multi-line links) and fmt.

  2. jsarenik renamed this:
    Jasan/little text fixes
    Docs: reflow the text and add better markup
    on Nov 23, 2017
  3. laanwj added the label Docs and Output on Nov 23, 2017
  4. Docs: INSTALL.md: Add monospace markup to file name 79a7c63c27
  5. Docs: CONTRIBUTING.md - reflow the text - no change in wording
    Though the plain text was pretty good (mostly 80-char lines),
    this makes it even more readable for terminal monks. The fancy
    HTML5 markdown output on GitHub is the same (checked with rendering
    original and changed file with `commonmarker` and normalizing both
    with HTML `tidy`, the only change being the simplified in-tree doc
    path for Translation Process).
    
    One more little change is that http://chris.beams.io was changed
    to https as suggested by @fanquake.
    
        commonmarker CONTRIBUTING.md | tidy > /tmp/aoeui.html
        git checkout master
        commonmarker CONTRIBUTING.md | tidy | diff -u - /tmp/aoeui.html
    1723a79fb4
  6. Docs: contrib/qos/README.md - fmt (reflow and wrap long lines) 56a2c5668a
  7. Doc: reflow release-notes.md 3f77cef2ed
  8. in CONTRIBUTING.md:50 in 69a8b2e75d outdated
      51 |  in init.cpp") in which case a single title line is sufficient. Commit messages should be
      52 |  helpful to people reading your code in the future, so explain the reasoning for
      53 | -your decisions. Further explanation [here](http://chris.beams.io/posts/git-commit/).
      54 | +your decisions. Further explanation [here].
      55 | +
      56 | +[here]: http://chris.beams.io/posts/git-commit/
    


    fanquake commented at 11:35 PM on November 25, 2017:

    If we're touching this please make this link https


    jsarenik commented at 9:25 AM on November 26, 2017:

    Thanks for suggestion. As the https link works, there it is now.

  9. fanquake commented at 10:58 AM on January 29, 2018: member

    Going to close this for now. Reflowing and reformatting text isn't a priority.

  10. fanquake closed this on Jan 29, 2018

  11. jsarenik commented at 11:41 AM on January 29, 2018: none

    @fanquake Fair enough, I see your point. In order to hit the priorities I think that one needs textual documentation which will be as readable as possible.

    See original and reflowed screenshots.

  12. DrahtBot locked this on Aug 18, 2022

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