Merge pull request #332 from bettersg/feat/improve-documentation

improved docs and added more types
bettersg · Jun 9, 2024 · 02af88e · 02af88e
2 parents 8c3702c + 262bb42
commit 02af88e
Show file tree

Hide file tree

Showing 15 changed files with 703 additions and 425 deletions.
diff --git a/.github/workflows/firebase-deploy.yml b/.github/workflows/firebase-deploy.yml
@@ -9,6 +9,8 @@ on:
     paths:
       - "functions/**"
       - "checkers-app/**"
+    paths-ignore:
+      - "README.md"
 
 jobs:
   build_and_deploy:

diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -1,10 +1,14 @@
 name: Run Tests
 on:
   pull_request:
+    paths-ignore:
+      - "README.md"
   push:
     branches:
       - develop
       - main
+    paths-ignore:
+      - "README.md"
 jobs:
   run_tests:
     runs-on: ubuntu-latest

diff --git a/README.md b/README.md
diff --git a/documentation/businessFlow.md b/documentation/businessFlow.md
diff --git a/documentation/checkersAppDevOnboarding.md b/documentation/checkersAppDevOnboarding.md
diff --git a/documentation/conversationFlow.md b/documentation/conversationFlow.md
diff --git a/documentation/dataSchema.md b/documentation/dataSchema.md