create documentation microsite (#56)

Adds a documentation microsite, and moves most contents of the readme over to the site 

Co-authored-by: Olivier Mélois <baccata64@gmail.com>
Co-authored-by: Jakub Kozłowski <jakub.kozlowski@disneystreaming.com>

.github/workflows/ci.yml

@@ -68,7 +68,7 @@ jobs:
         run: |
           sbt scalafmt_$BUILD_KEY \
               headerCheck \
-              "docs/mdoc --in $PWD/README.md"
+              "docs/mdoc"
 
       - name: Check for untracked changes
         run: |
@@ -118,3 +118,19 @@ jobs:
           PGP_SECRET: ${{ secrets.PGP_SECRET }}
           SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
           SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
+
+      - name: Compile Documentation Markdown Files
+        if: startsWith(github.ref, 'refs/tags/v') # do not run for snapshots
+        run: sbt "docs/mdoc"
+
+      - name: Build Microsite
+        if: startsWith(github.ref, 'refs/tags/v') # do not run for snapshots
+        run: cd ./modules/website && yarn build
+
+      - name: Publish Microsite
+        if: startsWith(github.ref, 'refs/tags/v') # do not run for snapshots
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./modules/website/build
+          publish_branch: gh-pages