Fix/codacy improvements (#1075)

* more md lint

* more md linting

Author: jkrauska

README-dev.md

@@ -2,9 +2,9 @@
 
 Coda is a new cryptocurrency protocol with a lightweight, constant sized blockchain.
 
-  * [Developer homepage](https://codaprotocol.com/code.html)
-  * [Roadmap](https://github.com/orgs/CodaProtocol/projects/1)
-  * [Repository Readme](README.md)
+* [Developer homepage](https://codaprotocol.com/code.html)
+* [Roadmap](https://github.com/orgs/CodaProtocol/projects/1)
+* [Repository Readme](README.md)
 
 If you haven't seen it yet, [CONTRIBUTING.md](CONTRIBUTING.md) has information
 about our development process and how to contribute. If you just want to build
@@ -29,27 +29,34 @@ Now you'll have a `src/_build/codaclient.deb` ready to install on Ubuntu or Debi
 ### Developer Setup
 
 #### Install or have Ubuntu 18
+
 * [VM Images](https://www.osboxes.org/ubuntu/)
 
 #### Setup Docker CE on Ubuntu
-  * [Ubuntu Setup Instructions](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
+
+* [Ubuntu Setup Instructions](https://docs.docker.com/install/linux/docker-ce/ubuntu/)
 
 #### Toolchain docker image
-  * Pull down developer container image  (~2GB download, go stretch your legs)\
+
+* Pull down developer container image  (~2GB download, go stretch your legs)
+
 `docker pull codaprotocol/coda:toolchain-e11592718bee89d2a4facfa7ca209844fa7b140c`
 
-  * Apply local customizatins\
+* Apply local customizations
+
 `make docker`
 
-  * Start developer container\
+* Start developer container
+
 `make container`
 
-  * Start a build (go stretch your arms)\
+* Start a build (go stretch your arms)
+
 `make USEDOCKER=TRUE build`
 
 #### Customizing your dev environment for autocomplete/merlin
-  * If you use vim, add this snippet in your vimrc to use merlin.\
-(REMEMBER to change the HOME directory to match yours)
+
+* If you use vim, add this snippet in your vimrc to use merlin. (REMEMBER to change the HOME directory to match yours)
 
 ```bash
 let s:ocamlmerlin="/Users/USERNAME/.opam/4.07/share/merlin"
@@ -58,15 +65,14 @@ execute "set rtp+=".s:ocamlmerlin."/vimbufsync"
 let g:syntastic_ocaml_checkers=['merlin']
 ```
 
-  * In your home directory `opam init`
-  * In this shell, `eval $(opam config env)`
-  * Now `/usr/bin/opam install merlin ocp-indent core async ppx_jane ppx_deriving` (everything we depend on, that you want autocompletes for) for doc reasons
-  * Make sure you have `au FileType ocaml set omnifunc=merlin#Complete` in your vimrc
-  * Install an auto-completer (such as YouCompleteMe) and a syntastic (such syntastic or ALE)
-
-  * If you use vscode, you might like these extensions
-     * [OCaml and Reason IDE](https://marketplace.visualstudio.com/items?itemName=freebroccolo.reasonml)
-     * [Dune](https://marketplace.visualstudio.com/items?itemName=maelvalais.dune)
+* In your home directory `opam init`
+* In this shell, `eval $(opam config env)`
+* Now `/usr/bin/opam install merlin ocp-indent core async ppx_jane ppx_deriving` (everything we depend on, that you want autocompletes for) for doc reasons
+* Make sure you have `au FileType ocaml set omnifunc=merlin#Complete` in your vimrc
+* Install an auto-completer (such as YouCompleteMe) and a syntastic (such syntastic or ALE)
+* If you use vscode, you might like these extensions
+  * [OCaml and Reason IDE](https://marketplace.visualstudio.com/items?itemName=freebroccolo.reasonml)
+  * [Dune](https://marketplace.visualstudio.com/items?itemName=maelvalais.dune)
 
 ## Using the makefile
 
@@ -77,13 +83,13 @@ You should probably use `USEDOCKER=TRUE` unless you've done the [building withou
 
 These are the most important `make` targets:
 
-  * `kademlia`: build the kademlia helper
-  * `build`: build everything
-  * `docker`: build the container
-  * `container`: restart the development container (or start it if it's not yet)
-  * `dev`: does `docker`, `container`, and `build`
-  * `test`: run the tests
-  * `web`: build the website, including the state explorer
+* `kademlia`: build the kademlia helper
+* `build`: build everything
+* `docker`: build the container
+* `container`: restart the development container (or start it if it's not yet)
+* `dev`: does `docker`, `container`, and `build`
+* `test`: run the tests
+* `web`: build the website, including the state explorer
 
 We use the [dune](https://github.com/ocaml/dune/) buildsystem for our OCaml code.
 
@@ -101,7 +107,7 @@ you need, you run `opam switch import src/opam.export`.
 Some of our dependencies aren't taken from `opam`, and aren't integrated
 with `dune`, so you need to add them manually:
 
-  * `opam pin add src/external/ocaml-sodium`
+* `opam pin add src/external/ocaml-sodium`
 
 There are a variety of C libraries we expect to be available in the system.
 These are also listed in the dockerfiles.
@@ -115,7 +121,7 @@ in the form of `dune exec coda -- integration-tests $SOME_TEST`.
 
 You might see a build error like this:
 
-```
+```text
 Error: Files external/digestif/src-c/.digestif_c.objs/digestif.cmx
        and external/digestif/src-c/.digestif_c.objs/rakia.cmx
        make inconsistent assumptions over implementation Rakia
@@ -127,6 +133,7 @@ Here, the offending path is `external/digestif/src-c/.diestif_c.objs`.
 ## Docker Image Family Tree
 
 Container Stages:
-* Stage 0: Initial Image [ocaml/opam2:debian-9-ocaml-4.07](https://hub.docker.com/r/ocaml/opam2/) (opam community image, ~880MB) 
+
+* Stage 0: Initial Image [ocaml/opam2:debian-9-ocaml-4.07](https://hub.docker.com/r/ocaml/opam2/) (opam community image, ~880MB)
 * Stage 1: [coda toolchain](https://github.com/CodaProtocol/coda/blob/master/dockerfiles/Dockerfile-toolchain) (built by us, stored on docker hub, ~2GB compressed)
 * Stage 2: [codabuilder](https://github.com/CodaProtocol/coda/blob/master/dockerfiles/Dockerfile) (built with `make docker`, used with `make build`, ~2GB compressed)

README.md

@@ -8,19 +8,20 @@ We have a [Discord server]( https://discord.gg/ShKhA7J)! Please come by if you
 need help or have questions. You might also be interested in the [OCaml
 Discord](https://discordapp.com/invite/cCYQbqN), for general OCaml help.
 
-# Table of Contents
+## Table of Contents
 
 * [Coda homepage](https://codaprotocol.com/)
 * [Roadmap](https://github.com/orgs/CodaProtocol/projects/1)
 * [Developer homepage](https://codaprotocol.com/code.html)
 * [Developer readme](README-dev.md)
 * [Compiling from source and and running a node](docs/demo.md)
 
-# Learn more
-*  [Directory structure](DIRECTORY_STRUCTURE.md)
-*  [Lifecycle of a transaction](docs/lifecycle_of_a_transaction_lite.md)
+## Learn more
 
-# License
+* [Directory structure](DIRECTORY_STRUCTURE.md)
+* [Lifecycle of a transaction](docs/lifecycle_of_a_transaction_lite.md)
+
+## License
 
 This repository is distributed under the terms of the Apache 2.0 license,
 available in the LICENSE fail and online at

rfcs/0000-template.md

@@ -1,47 +1,44 @@
-# Summary
+## Summary
 [summary]: #summary
 
 One paragraph explanation of the feature.
 
-# Motivation
+## Motivation
+
 [motivation]: #motivation
 
 Why are we doing this? What use cases does it support? What is the expected outcome?
 
-# Detailed design
+## Detailed design
+
 [detailed-design]: #detailed-design
 
 This is the technical portion of the RFC. Explain the design in sufficient detail that:
 
-- Its interaction with other features is clear.
-- It is reasonably clear how the feature would be implemented.
-- Corner cases are dissected by example.
+* Its interaction with other features is clear.
+* It is reasonably clear how the feature would be implemented.
+* Corner cases are dissected by example.
 
-# Drawbacks
+## Drawbacks
 [drawbacks]: #drawbacks
 
 Why should we *not* do this?
 
-# Rationale and alternatives
+## Rationale and alternatives
 [rationale-and-alternatives]: #rationale-and-alternatives
 
-- Why is this design the best in the space of possible designs?
-- What other designs have been considered and what is the rationale for not choosing them?
-- What is the impact of not doing this?
+* Why is this design the best in the space of possible designs?
+* What other designs have been considered and what is the rationale for not choosing them?
+* What is the impact of not doing this?
 
-# Prior art
+## Prior art
 [prior-art]: #prior-art
 
 Discuss prior art, both the good and the bad, in relation to this proposal.
-A few examples of what this can include are:
 
-# Unresolved questions
+## Unresolved questions
 [unresolved-questions]: #unresolved-questions
 
-- What parts of the design do you expect to resolve through the RFC process
-  before this gets merged?
-- What parts of the design do you expect to resolve through the implementation
-  of this feature before merge?
-- What related issues do you consider out of scope for this RFC that could be
-  addressed in the future independently of the solution that comes out of this
-  RFC?
+* What parts of the design do you expect to resolve through the RFC process before this gets merged?
+* What parts of the design do you expect to resolve through the implementation of this feature before merge?
+* What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC?