Merge pull request #81 from input-output-hk/fraser-iohk/documentation-cleanup

wip: minor documentation cleanup

Author: CarlosLopezDeLara

CONTRIBUTING.md

@@ -47,7 +47,7 @@ cabal build all
 Specific executables can be executed through cabal:
 
 ``` sh
-cabal run db-analyser
+cabal run kes-agent-control
 ```
 
 # Testing
@@ -83,26 +83,12 @@ This section contain guidelines on what to check when making a pull request.
 - When bumping version bounds on the dependencies *it is not necessary* to
   increase the package version number. See [this
   section](#updating-the-dependencies-bounds).
-- When you want to create a changelog entry, follow [this and the following
-  section](docs/website/contents/for-developers/ReleaseProcess.md#installing-scriv).
-
-## Following our git process
-
-Our [git process](docs/website/contents/for-developers/GitProcess.md) describes
-the `git` practices we encourage when working with the code in this repository.
 
 ## Updating the documentation
 
 When submitting a pull request, please look update the relevant parts of the
 documentation (see [this section](#documentation)).
 
-## Following the style guide
-
-We have a [Haskell style
-guide](docs/website/contents/for-developers/StyleGuide.md) that should be
-followed when writing code in Consensus. Our style guide is not set in stone,
-and improvements are always welcome.
-
 ## Formatting the code
 
 We use `fourmolu` for ensuring a consistent formatting style.

README.md

@@ -8,10 +8,12 @@ designed for forward security. In Cardano, we use this to sign blocks,
 
 This forward security however requires that after a key has been evolved, all
 copies of the old key must be securely erased. This implies that KES keys must
-never be stored on disk. The KES Agent, then, exists so that keys aren't lost
-in the event of a restart.
+never be stored on disk. The KES Agent exists so that KES keys can be securely
+stored in memory, rather than on disk, and will manage the evolution of KES keys
+in place of the node, allowing for the keys to persist (in ephemeral storage)
+even over a restart of the node itself.
 
-For further information, see [the Guide](docs/guide.markdown).
+For further information, see [the Guide](doc/guide.markdown).
 
 ## OS Compatibility
 
@@ -58,7 +60,7 @@ Querying the KES agent to verify that it works:
 KES_AGENT_CONTROL_PATH=/path/to/control.socket kes-agent-control info
 ```
 
-For further information, see [the Guide](docs/guide.markdown).
+For further information, see [the Guide](doc/guide.markdown).
 
 ## License & Copyright