docs(docs): Update and complete basic ARC42 Architecture specifications. (#3611)

* fix(general): remove unused Athena project directory (Athena is inside Hermes)

* fix(docs): make bullets indent by 4 to be compatible with standard markdown requirements

* docs(docs): Add into and goals to arc42 docs

* docs(docs): Update arc42 index

* docs(docs): add arc42 architecture constraints

* fix(docs): Cose Sign

* docs(docs): arc42 system scope

* docs(docs): Solution Strategy

* docs(docs): add arc42 building block view

* fix(docs): arc42 runtime view

* docs(docs): arc42 deployment view

* docs(docs): arc42 technical_risks

* docs(docs): arc42 glossary

* fix(docs): consistency updates

* docs(docs): Add ADRs and cleanup format and spelling

* docs(docs): fix markdown

* fix(docs): ADR Cleanup

Author: stevenj

.config/dictionaries/project.dic

@@ -29,6 +29,7 @@ autoresizing
 autovalidate
 backendpython
 backgrounding
+backpressure
 bech
 bimap
 bindgen
@@ -66,6 +67,7 @@ CNFT
 COCOAPODS
 codegen
 codepoints
+COEP
 collabs
 commitlog
 concatcp
@@ -266,6 +268,7 @@ Pdart
 permissionless
 pg_isready
 pinenacl
+PITR
 plpgsql
 podfile
 podhelper
@@ -306,6 +309,7 @@ ristretto
 rlib
 rngs
 rolname
+rollouts
 RPATH
 ruleset
 rustc

.markdownlint.jsonc

@@ -27,11 +27,11 @@
     // MD007/ul-indent - Unordered list indentation
     "MD007": {
         // Spaces for indent
-        "indent": 2,
+        "indent": 4,
         // Whether to indent the first level of the list
         "start_indented": false,
         // Spaces for first level indent (when start_indented is set)
-        "start_indent": 2
+        "start_indent": 4
     },
     // MD009/no-trailing-spaces - Trailing spaces
     "MD009": {

CONTRIBUTING.md

@@ -3,22 +3,22 @@
 First off, thanks for taking the time to contribute! ❤️
 
 * [Contributing to Catalyst Voices](#contributing-to-catalyst-voices)
-  * [Code of Conduct](#code-of-conduct)
-  * [I Have a Question](#i-have-a-question)
-  * [I Want To Contribute](#i-want-to-contribute)
-    * [Reporting Bugs](#reporting-bugs)
-      * [Before Submitting a Bug Report](#before-submitting-a-bug-report)
-      * [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
-    * [Suggesting Enhancements](#suggesting-enhancements)
-      * [Before Submitting an Enhancement](#before-submitting-an-enhancement)
-      * [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
-    * [Your First Code Contribution](#your-first-code-contribution)
-    * [Improving The Documentation](#improving-the-documentation)
-  * [Style guides](#style-guides)
-    * [Rust](#rust)
-    * [Dart](#dart)
-    * [Flutter](#flutter)
-    * [Commit Messages](#commit-messages)
+    * [Code of Conduct](#code-of-conduct)
+    * [I Have a Question](#i-have-a-question)
+    * [I Want To Contribute](#i-want-to-contribute)
+        * [Reporting Bugs](#reporting-bugs)
+            * [Before Submitting a Bug Report](#before-submitting-a-bug-report)
+            * [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report)
+        * [Suggesting Enhancements](#suggesting-enhancements)
+            * [Before Submitting an Enhancement](#before-submitting-an-enhancement)
+            * [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
+        * [Your First Code Contribution](#your-first-code-contribution)
+        * [Improving The Documentation](#improving-the-documentation)
+    * [Style guides](#style-guides)
+        * [Rust](#rust)
+        * [Dart](#dart)
+        * [Flutter](#flutter)
+        * [Commit Messages](#commit-messages)
 
 All types of contributions are encouraged and valued.
 Please make sure to read the relevant section before making your contribution.
@@ -75,11 +75,11 @@ Please complete the following steps in advance to help us fix any potential bug
 * Also make sure to search the internet (including Stack Overflow)
   to see if users outside the GitHub community have discussed the issue.
 * Collect information about the bug:
-  * Stack trace (Traceback)
-  * OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
-  * Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
-  * Possibly your input and the output
-  * Can you reliably reproduce the issue?
+    * Stack trace (Traceback)
+    * OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+    * Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+    * Possibly your input and the output
+    * Can you reliably reproduce the issue?
     And can you also reproduce it with older versions?
 
 #### How Do I Submit a Good Bug Report?

README.md

@@ -5,16 +5,16 @@
 Welcome to the Catalyst Voices mono repo, where we manage and maintain the interconnected projects.
 
 * [Catalyst Voices](#catalyst-voices)
-  * [Overview](#overview)
-  * [Getting Started](#getting-started)
-  * [Projects](#projects)
-    * [Athena](#athena)
-    * [Catalyst Voices](#catalyst-voices-1)
-    * [Catalyst Data Gateway](#catalyst-data-gateway)
-    * [Catalyst Voices Packages](#catalyst-voices-packages)
-  * [Development](#development)
-  * [Contributing](#contributing)
-  * [License](#license)
+    * [Overview](#overview)
+    * [Getting Started](#getting-started)
+    * [Projects](#projects)
+        * [Athena](#athena)
+        * [Catalyst Voices](#catalyst-voices-1)
+        * [Catalyst Data Gateway](#catalyst-data-gateway)
+        * [Catalyst Voices Packages](#catalyst-voices-packages)
+    * [Development](#development)
+    * [Contributing](#contributing)
+    * [License](#license)
 
 ## Overview
 

athena/.gitignore

@@ -1,13 +1,13 @@
 # Catalyst Data Gateway
 
 * [Catalyst Data Gateway](#catalyst-data-gateway)
-  * [Code Organization](#code-organization)
-    * [`./bin`](#bin)
-    * [`./crates`](#crates)
-    * [`./event-db`](#event-db)
-  * [Build and Run](#build-and-run)
-    * [Docker images](#docker-images)
-    * [Rust binary](#rust-binary)
+    * [Code Organization](#code-organization)
+        * [`./bin`](#bin)
+        * [`./crates`](#crates)
+        * [`./event-db`](#event-db)
+    * [Build and Run](#build-and-run)
+        * [Docker images](#docker-images)
+        * [Rust binary](#rust-binary)
 
 The Catalyst Data Gateway is the backend of the Catalyst Voices hosted stack.
 

athena/Cargo.toml

@@ -62,11 +62,11 @@ export CAT_GATEWAY_TEST_URL="http://127.0.0.1:3030"
 
 * Run the tests, by specifying one of the markers:
 
-  * ci (marks tests to be run in ci),
-  * nightly (marks tests to be run nightly),
-  * preprod_indexing (marks test which requires indexing of the cardano preprod network),
-  * health_endpoint (marks tests for health endpoint)
-  * health_with_proxy_endpoint (marks tests for health endpoint which requires a proxy for testing)
+    * ci (marks tests to be run in ci),
+    * nightly (marks tests to be run nightly),
+    * preprod_indexing (marks test which requires indexing of the cardano preprod network),
+    * health_endpoint (marks tests for health endpoint)
+    * health_with_proxy_endpoint (marks tests for health endpoint which requires a proxy for testing)
 
 ```shell
 poetry run pytest -s -m <marker>