updated documentation #144
Conversation
There was a problem hiding this comment.
Thanks a lot!
Couple comments/spelling suggestions here and there.
You've added quite a lot of pictures. My proposal for those would be to link all of them in a markdown file that we put in ./docs and link from the readme for easy overview.
Do you also have sources for these files (like draw.io xml or something). In this way, we can easily edit the documentation if things change.
You've committed a couple .DS_Store files. Can you remove those and add common MacOS tmp/metadata files to .gitignore?
README.md
Outdated
| @@ -1,5 +1,18 @@ | |||
| # StudyBits | |||
|
|
|||
| ##Table of contents | |||
There was a problem hiding this comment.
Needs a space between ## and title to render properly
README.md
Outdated
| ##Table of contents | ||
| 1. [Introduction](#introduction) | ||
| 2. [Contributing](#contributing) | ||
| 2.1 [Repository Structure](#structure) |
There was a problem hiding this comment.
I think this needs different alignment to properly render as nested list? (see https://help.github.com/en/articles/basic-writing-and-formatting-syntax#nested-lists)
README.md
Outdated
| The StudyBits repo consists of the following parts: | ||
|
|
||
| ``` | ||
| + ci |
There was a problem hiding this comment.
Would probably also use a nested list here (optional).
README.md
Outdated
|
|
||
| ``` | ||
| + ci | ||
| + Contains docker files used by trevor for ci. |
README.md
Outdated
| In order to develop for StudyBits a couple of dependencies need to be installed: | ||
|
|
||
| 1. Install [libindy](https://github.com/hyperledger/indy-sdk/tree/master/libindy) | ||
| The current version of StudyButs requires Libindy v1.6.6 to be installed, note that later versions are not supperted currently. |
| [Indy Node](https://github.com/hyperledger/indy-node) | ||
| [Indy Agents](https://github.com/hyperledger/indy-agent) | ||
| [indy plenum](https://github.com/hyperledger/indy-plenum/tree/master/docs) | ||
| [indy crypto](https://github.com/hyperledger/indy-crypto/blob/master/README.md) |
There was a problem hiding this comment.
Indy crypto is being phased out in favour of HyperLedger Ursa (which is basically a rename of indy-crypto)
README.md
Outdated
| [indy plenum](https://github.com/hyperledger/indy-plenum/tree/master/docs) | ||
| [indy crypto](https://github.com/hyperledger/indy-crypto/blob/master/README.md) | ||
|
|
||
| [Indy documentation old](https://wiki-archive.hyperledger.org/projects/indy/documentation) |
There was a problem hiding this comment.
Let's not link the old docs. The new docs are actually not at all being maintained either, so maybe let's remove them as well. Or move the collection of non-essential links to a separate page.
README.md
Outdated
| [Indy documentation new](https://hyperledger-indy.readthedocs.io/en/latest/) | ||
|
|
||
| #### Glossary | ||
| [sovrin glossary](https://docs.google.com/document/d/1giOzpTFXypJ6bAUp_6g93kYOEiNa5eWI1KeIg6wb598/edit) |
|
|
||
| To run backend locally, install libindy matching the version that is installed in the Dockerfile, [following their instructions](https://github.com/hyperledger/indy-sdk#installing-the-sdk) | ||
| #### Communication | ||
| [Agent-to-Agent communication videoexplaination](https://drive.google.com/file/d/1PHAy8dMefZG9JNg87Zi33SfKkZvUvXvx/view) |
There was a problem hiding this comment.
Haven't watched this, does it match the way we use an agent, or is it very specific to how the Indy people think agents should be built?
README.md
Outdated
|
|
||
| ### How to send a PR <a name="pullrequests"></a> | ||
|
|
||
| Before sending a PR make sure to be complient with the following: |
Improved documentation somewhat.
Still not amazing but it is an imporvement.