Optimize Quarto build: remove R, cache Python docs, exclude _source, scope lightbox

.github/workflows/deploy-docs-prod.yaml

@@ -59,12 +59,25 @@ jobs:
         with:
           version: ${{ vars.QUARTO_VERSION }}
 
+      - name: Get validmind-library SHA
+        id: lib-sha
+        run: echo "sha=$(git -C site/_source/validmind-library rev-parse HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Cache Python library docs
+        id: cache-python-docs
+        uses: actions/cache@v4
+        with:
+          path: site/validmind
+          key: python-docs-${{ steps.lib-sha.outputs.sha }}
+
       - name: Install Poetry
+        if: steps.cache-python-docs.outputs.cache-hit != 'true'
         run: |
           curl -sSL https://install.python-poetry.org | python3 -
           echo "$HOME/.local/bin" >> $GITHUB_PATH
 
       - name: Generate Python library docs
+        if: steps.cache-python-docs.outputs.cache-hit != 'true'
         run: |
           cd site/_source/validmind-library
           make install && make quarto-docs
@@ -81,6 +94,17 @@ jobs:
           cp -r site/_source/release-notes/releases site
           rm -f site/releases/backend-releases.qmd site/releases/cmvm-releases.qmd
 
+      - name: Cache Quarto site output
+        uses: actions/cache@v4
+        with:
+          path: |
+            site/_site
+            site/_freeze
+            site/.quarto
+          key: quarto-site-production-${{ hashFiles('site/_quarto.yml', 'site/_quarto-production.yml', 'site/theme.scss', 'site/styles.css', 'site/**/_sidebar.yaml', 'site/**/_sidebar.yml', 'site/_extensions/**') }}-${{ github.sha }}
+          restore-keys: |
+            quarto-site-production-${{ hashFiles('site/_quarto.yml', 'site/_quarto-production.yml', 'site/theme.scss', 'site/styles.css', 'site/**/_sidebar.yaml', 'site/**/_sidebar.yml', 'site/_extensions/**') }}-
+
       - name: Render prod docs site
         run: |
             cd site

.github/workflows/deploy-docs-staging.yaml

@@ -59,12 +59,25 @@ jobs:
         with:
           version: ${{ vars.QUARTO_VERSION }}
 
+      - name: Get validmind-library SHA
+        id: lib-sha
+        run: echo "sha=$(git -C site/_source/validmind-library rev-parse HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Cache Python library docs
+        id: cache-python-docs
+        uses: actions/cache@v4
+        with:
+          path: site/validmind
+          key: python-docs-${{ steps.lib-sha.outputs.sha }}
+
       - name: Install Poetry
+        if: steps.cache-python-docs.outputs.cache-hit != 'true'
         run: |
           curl -sSL https://install.python-poetry.org | python3 -
           echo "$HOME/.local/bin" >> $GITHUB_PATH
 
       - name: Generate Python library docs
+        if: steps.cache-python-docs.outputs.cache-hit != 'true'
         run: |
           cd site/_source/validmind-library
           make install && make quarto-docs
@@ -81,6 +94,17 @@ jobs:
           cp -r site/_source/release-notes/releases site
           rm -f site/releases/backend-releases.qmd site/releases/cmvm-releases.qmd
 
+      - name: Cache Quarto site output
+        uses: actions/cache@v4
+        with:
+          path: |
+            site/_site
+            site/_freeze
+            site/.quarto
+          key: quarto-site-staging-${{ hashFiles('site/_quarto.yml', 'site/_quarto-staging.yml', 'site/theme.scss', 'site/styles.css', 'site/**/_sidebar.yaml', 'site/**/_sidebar.yml', 'site/_extensions/**') }}-${{ github.sha }}
+          restore-keys: |
+            quarto-site-staging-${{ hashFiles('site/_quarto.yml', 'site/_quarto-staging.yml', 'site/theme.scss', 'site/styles.css', 'site/**/_sidebar.yaml', 'site/**/_sidebar.yml', 'site/_extensions/**') }}-
+
       - name: Render staging docs site
         run: |
             cd site

.github/workflows/validate-docs-site.yaml

@@ -59,12 +59,25 @@ jobs:
       with:
         version: ${{ vars.QUARTO_VERSION }}
 
+    - name: Get validmind-library SHA
+      id: lib-sha
+      run: echo "sha=$(git -C site/_source/validmind-library rev-parse HEAD)" >> $GITHUB_OUTPUT
+
+    - name: Cache Python library docs
+      id: cache-python-docs
+      uses: actions/cache@v4
+      with:
+        path: site/validmind
+        key: python-docs-${{ steps.lib-sha.outputs.sha }}
+
     - name: Install Poetry
+      if: steps.cache-python-docs.outputs.cache-hit != 'true'
       run: |
         curl -sSL https://install.python-poetry.org | python3 -
         echo "$HOME/.local/bin" >> $GITHUB_PATH
 
     - name: Generate Python library docs
+      if: steps.cache-python-docs.outputs.cache-hit != 'true'
       run: |
         cd site/_source/validmind-library
         make install && make quarto-docs
@@ -81,6 +94,17 @@ jobs:
         cp -r site/_source/release-notes/releases site
         rm -f site/releases/backend-releases.qmd site/releases/cmvm-releases.qmd
 
+    - name: Cache Quarto site output
+      uses: actions/cache@v4
+      with:
+        path: |
+          site/_site
+          site/_freeze
+          site/.quarto
+        key: quarto-site-development-${{ hashFiles('site/_quarto.yml', 'site/_quarto-development.yml', 'site/theme.scss', 'site/styles.css', 'site/**/_sidebar.yaml', 'site/**/_sidebar.yml', 'site/_extensions/**') }}-${{ github.sha }}
+        restore-keys: |
+          quarto-site-development-${{ hashFiles('site/_quarto.yml', 'site/_quarto-development.yml', 'site/theme.scss', 'site/styles.css', 'site/**/_sidebar.yaml', 'site/**/_sidebar.yml', 'site/_extensions/**') }}-
+
     - name: Render demo docs site
       run: |
           cd site

README.md

@@ -36,7 +36,7 @@ Some interactive tables, such as our breaking changes and dependency history rel
 > [!IMPORTANT]
 > First, read through and familiarize yourself with our [ValidMind style guide](https://docs.validmind.ai/about/contributing/style-guide/style-guide.html).
 
-- Our core user guides are sourced in Quarto Markdown under [`site/guide`](https://github.com/validmind/documentation/tree/main/site/guide). 
+- Our core user guides are sourced in Quarto Markdown under [`site/guide`](https://github.com/validmind/documentation/tree/main/site/guide).
 - If you create new documentation, make sure to add it to the [`_quarto.yml`](https://github.com/validmind/documentation/blob/main/site/_quarto.yml) file.
 
 If you are creating a pull request, test your changes by rendering or previewing the site. Note that if this is your first time contributing, you will be asked to sign a contributor license agreement (CLA).

site/_quarto.yml

@@ -4,6 +4,9 @@
 
 project:
   type: website
+  render:
+    - "**"
+    - "!_source/**"
 
 metadata-files:
   # - _drafts.yaml
@@ -267,8 +270,12 @@ format:
     link-external-icon: true
     callout-appearance: simple
     link-external-filter: '^https:\/\/(docs\.validmind\.ai|docs-staging\.validmind\.ai|docs-demo\.vm\.validmind\.ai)\/.*'
-    lightbox: true
+    lightbox: false
 
 filters:
   - tachyons
   - preview
+
+execute:
+  enabled: false
+  freeze: true

site/about/contributing/style-guide/conventions.qmd

@@ -4,6 +4,9 @@
 # SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial
 title: "Conventions"
 date: last-modified
+format:
+  html:
+    lightbox: true
 ---
 
 A message can only make an impact when it is received, so presentation is (almost) everything.

site/releases/2024/2024-dec-06/release-notes.qmd

@@ -1,6 +1,9 @@
 ---
 title: "December 6, 2024"
 date: 2024-12-06
+format:
+  html:
+    lightbox: true
 aliases: 
   - /releases/2024-dec-06/release-notes.html
 filters:

site/training/_metadata.yml

@@ -6,3 +6,4 @@ format:
   html:
     page-layout: full
     css: assets/training.css
+    lightbox: true