Publish docs site to prod

.github/actions/setup-r/action.yml

@@ -0,0 +1,33 @@
+name: "Setup R and install packages"
+description: "Sets up R and installs required packages for displaying interactive tables from .CSV"
+runs:
+  using: "composite"
+  steps:
+    - name: Set up R
+      uses: r-lib/actions/setup-r@v2
+      with:
+        r-version: '4.3'
+
+    - name: Cache R packages
+      uses: actions/cache@v3
+      with:
+        path: ${{ runner.os == 'Linux' && '/home/runner/work/_temp/Library' || runner.os == 'macOS' && '~/Library/R/4.3/library' }}
+        key: r-packages-${{ runner.os }}-${{ hashFiles('**/DESCRIPTION', '**/renv.lock') }}
+        restore-keys: |
+          r-packages-${{ runner.os }}-
+
+    - name: Install R packages
+      shell: bash
+      run: |
+        Rscript -e 'install.packages(c("DT", "readr", "stringr", "lubridate"), repos="https://cran.rstudio.com/")'
+
+    - name: Verify R installation
+      shell: bash
+      run: |
+        Rscript -e 'sessionInfo()'
+        which R
+
+    - name: Verify Quarto detects R
+      shell: bash
+      run: |
+        quarto check

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

@@ -25,6 +25,9 @@ jobs:
 
       - name: Fetch Quarto
         uses: ./.github/actions/fetch-quarto
+
+      - name: Setup R environment
+        uses: ./.github/actions/setup-r
 
       - name: Render prod docs site
         run: |

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

@@ -25,6 +25,9 @@ jobs:
 
       - name: Fetch Quarto
         uses: ./.github/actions/fetch-quarto
+
+      - name: Setup R environment
+        uses: ./.github/actions/setup-r
 
       - name: Render staging docs site
         run: |

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

@@ -25,6 +25,9 @@ jobs:
     - name: Fetch Quarto
       uses: ./.github/actions/fetch-quarto
 
+    - name: Setup R environment
+      uses: ./.github/actions/setup-r
+
     - name: Render demo docs site
       run: |
           cd site

README.md

@@ -24,6 +24,12 @@ You need:
 - The Quarto extension for your IDE, such as [VS Code](https://marketplace.visualstudio.com/items?itemName=quarto.quarto)
 - For Windows operating systems, install the `make` command via [Cygwin](https://cygwin.com/install.html)
 
+### Additional dependencies
+
+Some interactive tables, such as our breaking changes and dependency history rely you have R and some R packages installed in order for you to be able to preview or render certain pages of the docs site locally.
+
+**Refer to the [Breaking changes and deprecations](site/releases/breaking-changes/README.md) guide** for more information on how to install R and set up these tables.
+
 ## How to contribute
 
 > [!IMPORTANT]

site/Makefile

@@ -90,6 +90,11 @@ docs-site: get-source
 	quarto render --profile production
 	@$(MAKE) execute PROFILE=exe-prod
 
+# Get all source files
+docs-site-lite: get-source
+	@echo "\nRendering the static HTML site ..."
+	quarto render --profile production
+
 # Deployment to https://docs-demo.vm.validmind.ai/
 deploy-demo:
 	@if [ "`git rev-parse --abbrev-ref HEAD`" != "docs-demo" ]; then \
@@ -152,7 +157,7 @@ yearly-releases:
 execute:
 	quarto render --profile $(PROFILE) $(FILE_PATH)
 
-docker-build: docs-site
+docker-build: docs-site-lite
 	@echo "\nBuilding the Docker image ..."
 	@docker build -f ../Dockerfile -t validmind-docs ..
 

site/_quarto.yml

@@ -2,6 +2,9 @@ project:
   type: website
   post-render: make python-docs
 
+metadata-files:
+  - training/_sidebar.yaml
+
 website:
   announcement: 
     content: "[**{{< fa book-open-reader >}} EU AI Act Compliance**](https://validmind.com/download-whitepaper-the-eu-ai-act/) — Read our original regulation brief on how the EU AI Act aims to balance innovation with safety and accountability, setting standards for responsible AI use" 
@@ -197,6 +200,8 @@ website:
           - releases/2023/release-notes-2023-jul-24.qmd
           - releases/2023/release-notes-2023-jun-22.qmd
           - releases/2023/release-notes-2023-may-30.qmd
+        - text: "Breaking changes & deprecations"
+          file: releases/breaking-changes/breaking-changes.qmd
         - text: "---"
         - text: "Fine Print"
         - about/fine-print/data-privacy-policy.qmd

site/developer/model-testing/testing-overview.qmd

@@ -6,6 +6,7 @@ aliases:
 listing:
   - id: tests-beginner
     type: grid
+    grid-columns: 2
     max-description-length: 250
     sort: false
     fields: [title, description]
@@ -28,7 +29,7 @@ listing:
     max-description-length: 250
     sort: false
     fields: [title, description]
-    contents: 
+    contents:
     - ../../notebooks/code_samples/custom_tests/integrate_external_test_providers.ipynb
     - ../../notebooks/how_to/configure_dataset_features.ipynb
     - ../../notebooks/how_to/run_documentation_sections.ipynb
@@ -43,6 +44,7 @@ listing:
     contents: 
     - ../../notebooks/how_to/document_multiple_results_for_the_same_test.ipynb
     - ../../notebooks/how_to/load_datasets_predictions.ipynb
+    - ../../notebooks/how_to/understand_utilize_rawdata.ipynb
   - id: tests-custom
     type: grid
     max-description-length: 250

site/faq/faq-testing.qmd

@@ -37,10 +37,10 @@ Yes, {{< var vm.product >}} allows tests to be manipulated at several levels:
 - You can configure which tests are required to run programmatically depending on the model use case.[^4]
 - You can change the thresholds and parameters for default tests already available in the {{< var vm.developer >}} — for instance, changing the threshold parameter for the class imbalance flag.[^5]
 - You can also connect your own custom tests with the {{< var validmind.developer >}}. These custom tests are configurable and are able to run programmatically, just like the rest of the {{< var vm.developer >}}.[^6]
+- Personalize tests further for your use case by using {{< var vm.product >}}'s `RawData` feature[^7] to customize the output of tests.
 
 ::: {.callout}
-In addition to custom tests, you can also add use case and test-specific context for any test to enhance the LLM-generated test descriptions using the {{< var validmind.developer >}}.[^7]
-
+In addition to custom tests, you can also add use case and test-specific context for any test to enhance the LLM-generated test descriptions using the {{< var validmind.developer >}}.[^8]
 :::
 
 {{< include _faq-explainability.qmd >}}
@@ -69,4 +69,6 @@ In addition to custom tests, you can also add use case and test-specific context
 
 [^6]: [Can I use my own tests?](/developer/model-testing/testing-overview.qmd#can-i-use-my-own-tests)
 
-[^7]: [Add context to LLM-generated test descriptions](/notebooks/how_to/add_context_to_llm_descriptions.ipynb)
+[^7]: [Understand and utilize `RawData` in {{< var vm.product >}} tests](/notebooks/how_to/understand_utilize_rawdata.ipynb)
+
+[^8]: [Add context to LLM-generated test descriptions](/notebooks/how_to/add_context_to_llm_descriptions.ipynb)

site/guide/guides.qmd

@@ -145,34 +145,13 @@ Then, work with documentation and customizable templates, and collaborate with m
 :::{#guides-model-documentation}
 :::
 
-::: {.grid}
-::: {.g-col-8}
-{{< video https://www.youtube.com/embed/videoseries?si=aP7yLOGO60h4vi8C&amp;list=PL7I7ZrCoVCCP876aLRCjitZqYif96Whlz title='Developer Fundamentals' >}}
-
-::: {.video-cap .tc}
-(10 videos)
-:::
-
-:::
-:::
-
 ## Model validation
 
 Set up validation guidelines and prepare validation reports, work with findings and evidence, and collaborate with model developers within the {{< var vm.platform >}}:
 
 :::{#guides-model-validation}
 :::
 
-::: {.grid}
-::: {.g-col-8}
-{{< video https://www.youtube.com/embed/videoseries?si=JfBNClmsZYLS7m9F&amp;list=PL7I7ZrCoVCCObEiuLLAL0Wm9GQ6x5U0q5 title='Validating Models 101' >}}
-
-::: {.video-cap .tc}
-(5 videos)
-::: 
-
-:::
-:::
 
 Review reports or export your documentation for external records: