Update GitHub Pages deployment workflow

.github/workflows/gh-pages.yml

@@ -3,8 +3,6 @@ name: github-pages
 on:
     push:
       branches: [ main ]
-    pull_request:
-        branches: [ main ]
 
 permissions:
     contents: read
@@ -21,7 +19,6 @@ jobs:
     publish-docs:
       environment:
         name: github-pages
-        url: ${{ steps.deployment.outputs.page_url }}
       runs-on: ubuntu-latest
       steps:
       - name: Checkout
@@ -36,11 +33,12 @@ jobs:
 
       - name: Setup Pages
         uses: actions/configure-pages@v3
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
-        with:
-          # Upload entire repository
-          path: 'docs/_site'
       - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2
+        if: |
+            github.event.repository.fork == false &&
+            github.ref_name == github.event.repository.default_branch
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            publish_dir: docs/_site
+            cname: docs.foundationallm.ai

README.md

@@ -37,6 +37,10 @@ The core problems to deliver enterprise copilots are:
 - The top AI risks (inaccuracy, cybersecurity, compliance, explainability, privacy) are not being mitigated.
 - Delivery of a copilot solution is time consuming, expensive and frustrating.
 
+## Documentation
+
+Get up to speed with Foundationa**LLM** by reading the [documentation](https://docs.foundationallm.ai). This includes deployment instructions, quickstarts, architecture, and API references.
+
 ## Getting Started
 
 FoundationalLLM provides a simple command line driven approach to getting your first deployment up and running. Basically, it's two commands. After that, you can customize the solution, run it locally on your machine and update the deployment with your customizations.