[GH-24] Add understandable documentation for non-developers #81
Conversation
docs/Document.md
Outdated
| * Network | ||
| * Wallet backend | ||
|
|
||
| The shell will act as an **glue** of these features. It provides required resources/configurations to each of these features as well as resolving its dependencies. |
There was a problem hiding this comment.
Yes you're right. Will fix this.
There was a problem hiding this comment.
Well, it's a good step towards that kind of documentation, but beside the one-pager which can be relatively technical since it will be read by a technical person, this document should be a really simple overview of what the project does. So imagine you are (trying to) explain(ing) this to somebody who doesn't know anything about Haskell, IOHK or cryptocurrencies. This document is for them, a public-facing overview of what the project does.
docs/Document.md
Outdated
| together and makes sure that they have the required resources | ||
| (configuration, exception handling, monitoring, logging, ...). | ||
|
|
||
| The shell is also responsible for: |
There was a problem hiding this comment.
The shell is not responsible for logging and monitoring. That is brought in using the library, which is a part of shell (the part that can add features).
docs/Document.md
Outdated
| * Network layer | ||
| * Wallet backend layer | ||
|
|
||
| The shell will act as a **glue** of these features. It provides required |
There was a problem hiding this comment.
The idea is that it will be a glue for some of them.
Create an document explaining what the shell does for non-developers.