fix(docs): Test that github actions for docs complete properly on merge to main. (#132)

* refactor(gateway): Rename catalyst-voices-backend to the catalyst-gateway

* docs(gateway): Update readme

* refactor(gateway): Move the code into the new directory trees, cleanup inside tree still todo.

* refactor(gateway): Basic refactor of the event-db config/data and the db interface logic

* docs(gateway): Initial docs for the crates directory inside catalyst gateway

* refactor(gateway): Move code out of cat-data-service and put it directly in bin

* feat(gateway): first build seems to work, but fails due to WIP refactor

* refactor(gateway): Refactor builds properly to a static executable.

* refactor(gateway): autofixed lints

* refactor(gateway): WIP remove lint errors

* refactor(gateway): WIP refactoring work to remove lint errors

* refactor(gateway): Don't panic, return the error, and generalize the error itself.

* refactor(gateway): generalize error response

* docs(gateway): indexing ok here, slice already checked to have values

* refactor(gateway): Indexing is safe here, so note it.

* refactor(gateway): don't panic, return an error.  reduce size of function by splitting into multiple logical units.

* refactor(gateway): Purge metrics from legacy service.  Unused and can panic.

* refactor(gateway): remove unused rust files from EventDB directory

* refactor(gateway): remove unused dependencies

* docs(gateway): Allow intentional panic for test code

* refactor(gateway): eliminate or notate why unwraps/expect are safe

* refactor(gateway): All lints are clean and restrictively applied

* refactor(gateway): remove unused dependencies from workspace cargo file

* refactor(gateway): restrict visibility of event_db to pub(crate) as its fully internalized now.

* docs(gateway): root level fully documented

* docs(gateway): state fully documented

* docs(gateway): Don't worry about full docs for legacy service.

* docs(gateway): Service top level fully documented

* docs(gateway): middleware docs complete

* docs(gateway): Fully documented the docs part of the service

* docs(gateway): common responses and module root fully documented

* docs(gateway): Common objects now fully documented

* docs(gateway): Api endpoint docs are complete

* docs(gateway): DB Types fully documented

* docs(gateway): Queries partially documented

* docs(gateway): Everything that needs docs is documented

* feat(gateway): Initial CI and Cat-Gateway build ready for PR

* feat(rust): Add recommended rust extensions for vscode, and rust settings.

* docs(gateway): Fix spelling

* ci(gateway): Use the proper versioned CI tooling from catalyst-ci

* feat(docs): Docs WIP setup

* docs(docs): Fix the docs so they use the latests docs-ci and are able to properly include data from build targets

* docs(docs): fix spelling and markdown lint issues

* docs(docs): Update to use latest Cat-CI Docs and reduce replication

* docs(docs): Fix the top level parts of the docs and remove test values

* docs(docs): try and build and deploy docs to gh-pages

* docs(docs): fix spelling issue

* docs(docs): Use proper docs action, and also add branch cleanup for branch docs

* docs(docs): Use the published versions from Catalyst-CI

* docs(docs): Ensure we do not try and clean docs while building them.

* docs(docs): Ensure we don't try and build docs simultaneously, Don't build docs for tags.

* ci(mdlint): Use tagged CI versions for stability

* ci(spelling): Use tagged CI versions for stability

* docs(docs): Edit docs so we test deployment

Author: stevenj

.github/workflows/docs.yml

@@ -4,8 +4,10 @@ name: Docs
 
 on:
   push:
+    branches:
+      - "**"
     tags-ignore:
-      - "*"
+      - "**"
 
 concurrency:
   group: "docs"
@@ -18,7 +20,7 @@ permissions:
 
 jobs:
   ci:
-    uses: input-output-hk/catalyst-ci/.github/workflows/pages.yml@v2.0.6
+    uses: input-output-hk/catalyst-ci/.github/workflows/pages.yml@master
     with:
       aws_role_arn: arn:aws:iam::332405224602:role/ci
       aws_region: eu-central-1

docs/src/monorepo-architecture/index.md

@@ -4,3 +4,5 @@ icon: material/pencil-ruler
 
 <!-- markdownlint-disable MD025-->
 # Monorepo Architecture
+
+TODO, add description and diagram of Monorepo architecture.