Documentation Cleanup and Contrib Index #3085

pull super3 wants to merge 1 commits into bitcoin:master from super3:master changing 6 files +67 −39

super3 commented at 3:08 PM on October 12, 2013: contributor

See Bitcoin Pull #2902 for more info on the documentation cleanup. Added an index to the /contrib folder to make it a little bit more readable. Will squash when commit is satisfactory.
Michagogo commented at 5:40 PM on October 12, 2013: contributor

On my phone, so haven't reviewed this thoroughly nor can I add a comment directly on the diff, but the bump of version numbers wasn't an oversight or anything -- master was built on top of 0.8.2, and 0.8.(3-5) were branched off of there. If you'll look at the tags, the last (or one of the last) commits before the release is tagged tends to be a version number bump across multiple files. What's more, by the time this commit makes it into a release, it won't be 0.8.5, it will most likely be 0.9.0, but we don't know yet. Not that it hurts to make this change per se, but it's not necessary.

sipa commented at 5:53 PM on October 12, 2013: member

Maybe this helps illustrating:

0.8.0 -- 0.8.1 -- 0.8.2 ---------------------------------- HEAD (-- 0.9.0)
                        \
                          \- 0.8.3 -- 0.8.4 -- 0.8.5 (-- 0.8.6)

super3 commented at 10:23 PM on October 12, 2013: contributor

Gotcha and reverted. Anything else?

Documentation Cleanup in /Doc

Added some help text, and bumped version numbers.

Added a Readable Index for /Contrib

Fixing /Contrib Index URLs

Revert Version Numbers.

0aa9851b18

BitcoinPullTester commented at 11:08 PM on October 12, 2013: none

Automatic sanity-testing: PASSED, see http://jenkins.bluematt.me/pull-tester/0aa9851b188d5f5144debfabb249bd44ec56ea65 for binaries and test log. This test script verifies pulls every time they are updated. It, however, dies sometimes and fails to test properly. If you are waiting on a test, please check timestamps to verify that the test.log is moving at http://jenkins.bluematt.me/pull-tester/current/ Contact BlueMatt on freenode if something looks broken.
in doc/README.md:None in 0aa9851b18
```
   8 |  Distributed under the [MIT/X11 software license](http://www.opensource.org/licenses/mit-license.php).
   9 |  This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](http://www.openssl.org/). This product includes
  10 |  cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.
  11 |  
  12 | -
  13 | -Intro
```
sipa commented at 8:25 PM on October 13, 2013:

Any reason for deleting this section?

super3 commented at 8:36 PM on October 13, 2013:

#2902

"What is Bitcoin?" seems sufficient in the root README. Now that I think about it I think the section could be expanded to a brief summarization and direct link to the paper. Thoughts?

sipa commented at 8:38 PM on October 13, 2013:

No objection - I was mostly reviewing this as formatting-change-only commit.

super3 commented at 9:04 PM on October 13, 2013:

Just trying to streamline, and make the repo more readable. Most of my commits will be formatting for now as I learn my way around the codebase. Let let me know if you have any suggestions.
sipa commented at 9:21 PM on October 13, 2013: member

ACK
gavinandresen referenced this in commit e16c2b4422 on Oct 16, 2013
gavinandresen merged this on Oct 16, 2013
gavinandresen closed this on Oct 16, 2013
Bushstar referenced this in commit ac90abe892 on Apr 8, 2020
DrahtBot locked this on Sep 8, 2021

Contributors

Linked (view graph)

#2902 Root and /Doc Readme Cleanup.