docs: documentation overhaul (#141)

docs/README.md

@@ -0,0 +1,45 @@
+---
+description: >-
+  The Aries CLI has one simple goal: to make self-sovereign identity development
+  easier.
+---
+
+# Introduction to the Aries CLI
+
+The Aries CLI is a development tool that assists you with your Aries based self-sovereign identity development.
+
+The CLI makes it easy to create schemas, definitions and credentials, so you can test your Aries application. You can use it both for individual actions or to run automations.
+
+{% hint style="info" %}
+Currently, the Aries CLI is on its first release. If you have any feature requests, bugs or recommendations, we'd love to hear them! Open issues or contribute through PRs on our [GitHub](https://github.com/animo/aries-cli) repo.
+{% endhint %}
+
+There are three options to get started with the CLI. You can start without any setup with our community agent. You can connect your GitHub and claim a token to get an individual tenant environment using our multitenant agent. Or you can connect your own development agent to the CLI. Both community agents are free to use and hosted by [Animo Solutions](https://animo.id). Follow [this guide](guides/configuration.md) for set up. 
+
+{% hint style="info" %}
+The Aries CLI is free to use and specifically for development purposes. Both community agents will occasionally need maintenance or have to be reset. Keep an eye on the [Discord](https://discord.gg/vXRVNh3DYD) for announcements and news. 
+{% endhint %}
+
+### Quickstart
+
+Are you experienced with CLI's and SSI development? The CLI has plenty of built-in documentation to figure it out yourself. Just [install ](guides/installation.md)and run `aries-cli` to get an overview of the features and usage.
+
+We do recommend taking a quick look at our [configuration guide](guides/configuration.md), as the more experienced developer will probably want to use our tenant environment option or connect their own agent.
+
+### Getting started
+
+Curious how you can use the Aries CLI? You can follow these guides to get everything up and running in no time.
+
+{% content-ref url="guides/installation.md" %}
+[installation.md](guides/installation.md)
+{% endcontent-ref %}
+
+{% content-ref url="guides/configuration.md" %}
+[configuration.md](guides/configuration.md)
+{% endcontent-ref %}
+
+{% content-ref url="guides/using-the-aries-cli.md" %}
+[using-the-aries-cli.md](guides/using-the-aries-cli.md)
+{% endcontent-ref %}
+
+All features are highlighted both in these docs as in the CLI through the `--help` option.

docs/SUMMARY.md

@@ -0,0 +1,29 @@
+# Table of contents
+
+* [Introduction to the Aries CLI](README.md)
+
+## Guides
+
+* [Installation](guides/installation.md)
+* [Set up the Aries CLI](guides/configuration.md)
+* [Using the Aries CLI](guides/using-the-aries-cli.md)
+
+## Features
+
+* [Overview](features/introduction.md)
+* [Connection](features/connections.md)
+* [Credential Definition](features/credential-definitions.md)
+* [Credential](features/credentials.md)
+* [Schema](features/schemas.md)
+* [Message](features/messages.md)
+* [Configuration](features/environments.md)
+
+## Automations
+
+* [Overview](automations/introduction.md)
+* [Offer credential](automations/usage.md)
+
+## Community
+
+* [Roadmap](community/roadmap.md)
+* [Contributing](community/contributing.md)

docs/automations/introduction.md

@@ -0,0 +1,26 @@
+---
+description: Automated actions that combine multiple functions
+---
+
+# Introduction
+
+Aries CLI supports automations that combine multiple functions into one single command. Currently, the goal of automations is to shortcut some convenient development situations, in the future they might evolve to be more complex. 
+
+### Usage
+
+```
+aries-cli automate <SUBCOMMAND>
+```
+
+#### Options
+
+| Alias | Flag     | Description             |
+| ----- | -------- | ----------------------- |
+| `-h`  | `--help` | Print help information. |
+
+#### Subcommands
+
+| Command                      | Description                                                                     |
+| ---------------------------- | ------------------------------------------------------------------------------- |
+| [credential-offer](usage.md) | Simple credential offer automation to offer a premade credential to any agent.  |
+

docs/automations/usage.md

@@ -0,0 +1,44 @@
+# Offer credential
+
+This simple command will result in a credential offer for a mocked credential that can be accepted immediately by scanning the generated QR code or using the URL. 
+
+### Usage
+
+```
+aries-cli automate credential-offer
+```
+
+#### Options
+
+| Alias | Flag                              | Description                                             |
+| ----- | --------------------------------- | ------------------------------------------------------- |
+| `-h`  | `--help`                          | Print help information.                                 |
+| `-c`  | `--connection-id <CONNECTION_ID>` | Connection id of the receiving party.                   |
+| `-n`  | `--no-qr`                         | Disables printing the QR code.                          |
+| `-s`  | `--self`                          | Completes the entire flow with itself.                  |
+| `-t`  | `--timeout <TIMEOUT>`             | Timeout for the entire flow in seconds \[default : 60]. |
+
+
+
+#### Example usage
+
+```
+aries-cli automate credential-offer
+```
+
+First, you will receive a connection invitation in your wallet, after which you will receive the offered credential. The credential is named default and contains several types of attribute.&#x20;
+
+```json
+{
+    "Bank": "qBank New York",
+    "Name": "Joyce Brown",
+    "Valid Until": "20251212",
+    "Card Number": "4537-6696-0666-0146",
+    "City": "New York",
+    "Date Of Birth": "19890321",
+    "Street": "Main Road 207",
+    "Security Code": "063",
+}
+
+```
+

docs/community/contributing.md

@@ -0,0 +1,47 @@
+---
+description: >-
+  Feel free to contribute to the repository by forking and submitting a pull
+  request!
+---
+
+# Contributing
+
+We welcome contributions that to make the CLI better. If you do not have a specific contribution in mind, we encourage you to look for issues labelled as [`good first issue`](https://github.com/animo/aries-cli/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) or look at our [roadmap](roadmap.md).
+
+For significant changes, please open an issue first to discuss the proposed changes with the community to avoid re-work.
+
+(If you are new to GitHub, you might start with a [basic tutorial](https://docs.github.com/en/get-started/quickstart/set-up-git) and check out a more detailed guide to [pull requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).)
+
+Pull requests will be evaluated by the repository guardians on a schedule and if deemed beneficial will be committed to the main branch. Pull requests should have a descriptive name and include a summary of all changes made in the pull request description.
+
+### Fixes
+
+If you have a fix, go straight to [Getting set up](contributing.md#getting-set-up).
+
+### Features
+
+If you have something bigger in mind (structural changes, new features) we strongly encourage you to create a new GitHub issue that documents:
+
+* motivate the changes you want to make
+* how you want to make them
+
+This gives your new idea the best chance to get accepted by the repository maintainers.
+
+### Getting set up
+
+```
+git clone https://github.com/animo/aries-cli.git
+```
+
+Once you have the code locally, you should be able to test out the current source code by running:
+
+```
+# "cargo run -q --" instead of aries-cli
+cargo run -q -- <cmd>
+```
+
+#### Tests
+
+We love tests, but recognize that there is a shortage of them at the moment. We encourage you to take a look at [Rust's guide](https://doc.rust-lang.org/book/ch11-01-writing-tests.html) on how to create an automated test. We are happy to provide support for writing tests on the PR.
+
+Currently a simple suite of tests can be executed by running `./tests/run.sh`.

docs/community/roadmap.md

@@ -0,0 +1,26 @@
+---
+description: Where we are and where we are heading, let us know what you want to see next!
+---
+
+# Roadmap
+
+You can keep track of issues and PRs by following our [GitHub repo](https://github.com/animo/aries-cli) (make sure to star if you enjoy). Community input it very appreciated, either by [opening issues/reporting bugs](https://github.com/animo/aries-cli/issues),  [contributing](contributing.md) yourself or by leaving a message in the [Discord](https://discord.gg/vXRVNh3DYD). 
+
+* ✅ Support multiple environments.
+* ✅ Connections.
+* ✅ Schemas.
+* ✅ Credentials.
+* ✅ ACA-Py 0.7.3 support.
+* ✅ Verbosity levels and extensive logging.
+* ✅ Automation: offer credential with mocked data.
+* ✅ Community agent support.
+* ✅ Tenant support through multitenant agent + personal token.
+* ✅ Brew install.
+* ✅ Proofs.
+* 🚧 Apt-get installation.
+* 🚧 Chocolaty installation.
+* 🚧 Automation: offer credential with custom data.
+* 🚧 Filters for output.
+* 🚧 Automation: schema + credential definition with custom data.
+* 🚧 Automation: present proof with mock data.
+* 🚧 Automation: present proof with custom data.