Heavy rework on documentation

[legacycode]

Hi,
i did a lot of restructuring the existing documentation. The documentation now automatically renders on readthedocks.io. I think this is a great new user experience :-)

I hope you like my suggestions. You can preview the new documentation at: https://btcd.readthedocs.io/

I like this kind of documentation. That was a lot of work. Hopefully this will be merged :-)
/legacycode

[octobocto]

readthedocs is very nice, maybe add a link to it in the main README?

I think it would be nice to delete docs/table_of_contents.md and rename docs/index.md to docs/README.md because README.md is a natural starting point, index is not

[jakesylvestre]

LGTM once the merge conflict is resolvd

[legacycode]

@jakesyl done

[jakesylvestre]

Thanks!

[jakesylvestre]

@jcvernaleo (as per #1530)

• low priority
• documentation

This probably does make sense to merge sooner rather than later since I've already had @legacycode rework this once and new PRs will likely cause conflicts that he'll have to deal with again

[onyb]

Kudos for doing this! The btcd.readthedocs.io will probably show up in the top search results of Google, and this will serve as a great intro for people to get started.

I added some minor remarks. My global feedback is about filenames, which is very important since they get transformed into URLs directly. They should be:

• Short (use abbreviations if required).
• Use hyphenations, instead of underscores.

[onyb]

@legacycode Any update on this? The CI needs to be fixed in order to merge this.

[jakesylvestre]

That and needs to be rebased

[legacycode]

@onyb @jakesyl Rebased and CI passed. Ready for merge :-)

[jakesylvestre]

LGTM!

[legacycode]

@jakesyl Great. I released the subdomain btc.readthedocs.org on https://readthedocs.org/dashboard/ Please make sure that somebody of your team create/administrate the project at readthedocs.org. It's a one time process.