Publish to prod adjustment — March 11, 2025

site/_quarto.yml

@@ -39,12 +39,12 @@ website:
         file: guide/guides.qmd
       - text: "{{< fa cube >}} Developers"
         menu:
-        - text: "{{< fa rocket >}} Get Started"
-          file: developer/get-started-validmind-library.qmd
+        - text: "{{< fa laptop-code >}} {{< var validmind.developer >}}"
+          file: developer/validmind-library.qmd
         - text: "{{< fa cubes >}} Supported Models"
-          file: developer/model-documentation/supported-models.qmd
-        - text: "{{< fa book-medical >}} Documenting Models"
-          file: developer/model-documentation/documenting-models.qmd
+          file: developer/supported-models.qmd
+        - text: "{{< fa rocket >}} QuickStart Notebook"
+          file: notebooks/quickstart_customer_churn_full_suite.ipynb
         - text: "---"
         - text:  "{{< fa vial >}} TESTING"
         - text: "{{< fa flask-vial >}} Run Tests & Test Suites"
@@ -63,11 +63,9 @@ website:
           file: https://jupyterhub.validmind.ai/
         - text: "---"
         - text: "{{< fa book >}} REFERENCE"
-        - text: "{{< fa external-link >}} {{< var validmind.developer >}}"
+        - text: "{{< fa external-link >}} {{< var validmind.developer >}} API"
           file: validmind/validmind.html
           target: _blank
-      - text: "FAQ"
-        file: faq/faq.qmd
       - text: "Support"
         file: support/support.qmd
       - text: "Training"
@@ -88,14 +86,12 @@ website:
           file: get-started/get-started.qmd
         - text: "{{< fa book >}} Guides"
           file: guide/guides.qmd
-        - text: "{{< fa circle-question >}} FAQ"
-          file: faq/faq.qmd
         - text: "{{< fa envelope-open-text >}} Support"
           file: support/support.qmd
         - text: "---"
         - text:  "{{< fa cube >}} Developers"
         - text: "{{< fa code >}} {{< var validmind.developer >}}"
-          file: developer/get-started-validmind-library.qmd
+          file: developer/validmind-library.qmd
         - text: "---"
         - text:  "{{< fa graduation-cap >}} {{< var validmind.training >}}"
         - text: "{{< fa building-columns >}} Training Courses"
@@ -283,21 +279,20 @@ website:
         - file: guide/model-documentation/working-with-documentation-templates.qmd
           contents:
           - guide/model-documentation/view-documentation-templates.qmd
-#          - guide/import-documentation-templates.qmd
           - guide/model-documentation/customize-documentation-templates.qmd
           - guide/model-documentation/swap-documentation-templates.qmd
         - file: guide/model-documentation/working-with-model-documentation.qmd
           contents:
           - guide/model-documentation/view-documentation-guidelines.qmd
           - guide/model-documentation/work-with-content-blocks.qmd
+          - guide/model-documentation/work-with-test-results.qmd
           - text: "Assign section statuses"
             file: guide/model-documentation/assign-documentation-section-statuses.qmd
           - guide/model-documentation/collaborate-with-others.qmd
           - guide/model-documentation/submit-for-approval.qmd
         - guide/model-documentation/export-documentation.qmd
         - text: "---"
         - text: "Model Validation"
-#        - guide/customize-validation-report-templates.qmd
         - guide/model-validation/manage-validation-guidelines.qmd
         - file: guide/model-validation/preparing-validation-reports.qmd
           contents:
@@ -333,21 +328,25 @@ website:
       contents:
       # USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW
         - text: "ValidMind Library"
-          file: developer/get-started-validmind-library.qmd
+          file: developer/validmind-library.qmd
+        - developer/supported-models.qmd
         - text: "---"
-        - text: "Model Documentation"
+        - text: "QuickStart"
         - notebooks/quickstart_customer_churn_full_suite.ipynb
-        - text: "Introduction for model developers"
-          file: notebooks/tutorials/intro_for_model_developers.ipynb
-        - developer/model-documentation/supported-models.qmd
-        - file: developer/model-documentation/documenting-models.qmd
-          contents:
-            - developer/model-documentation/document-models.qmd 
-            # USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
-            - text: "Install and initialize ValidMind Library"
-              file: developer/model-documentation/install-and-initialize-validmind-library.qmd 
-            - developer/model-documentation/work-with-test-results.qmd
-            - developer/model-documentation/store-credentials-in-env-file.qmd
+        - text: "Install and initialize ValidMind Library"
+          file: developer/model-documentation/install-and-initialize-validmind-library.qmd 
+        - developer/model-documentation/store-credentials-in-env-file.qmd
+        - text: "---"
+        - text: "Model Development"
+        # USING THE VARIABLE IN THE LINK TEXT MESSES UP THE MOBILE VIEW & BREADCRUMB
+        - text: "<sup>101</sup> Set up ValidMind Library"
+          file: notebooks/tutorials/model_development/101-set_up_validmind.ipynb
+        - text: "<sup>102</sup> Start model development process"
+          file: notebooks/tutorials/model_development/102-start_development_process.ipynb
+        - text: "<sup>103</sup> Integrate custom tests"
+          file: notebooks/tutorials/model_development/103-integrate_custom_tests.ipynb
+        - text: "<sup>104</sup> Finalize testing & documentation"
+          file: notebooks/tutorials/model_development/104-finalize_testing_documentation.ipynb
         - text: "---"
         - text: "Model Testing"
         - text: "Run tests & test suites"
@@ -364,36 +363,33 @@ website:
           contents: "notebooks/code_samples/**"
         - text: "---"
         - text: "Reference"
-        - text: "{{< var validmind.developer >}} {{< fa external-link >}}"
+        - text: "{{< var validmind.developer >}} API"
           file: validmind/validmind.html
           target: _blank
 
-    - title: "FAQ"
-      contents:
-        - faq/faq.qmd
-        - text: "---"
-        - text: "Access & permissions"
-          file: faq/faq-organizations.qmd
-        - faq/faq-workflows.qmd
-        - text: "Inventory & activity"
-          file: faq/faq-inventory.qmd
-        - text: "Documentation & templates"
-          file: faq/faq-documentation.qmd
-        - text: "Validation & findings"
-          file: faq/faq-validation.qmd
-        - faq/faq-collaboration.qmd
-        - text: "Monitoring & reporting"
-          file: faq/faq-reporting.qmd
-        - faq/faq-testing.qmd
-        - faq/faq-integrations.qmd
-        - text: "Data & privacy"
-          file: faq/faq-privacy.qmd
-
     - title: "Support"
       contents:
         - support/support.qmd
-        - text: "---"
         - support/troubleshooting.qmd
+        - text: "---"
+        - file: faq/faq.qmd
+          contents:
+            - text: "Access & permissions"
+              file: faq/faq-organizations.qmd
+            - faq/faq-workflows.qmd
+            - text: "Inventory & activity"
+              file: faq/faq-inventory.qmd
+            - text: "Documentation & templates"
+              file: faq/faq-documentation.qmd
+            - text: "Validation & findings"
+              file: faq/faq-validation.qmd
+            - faq/faq-collaboration.qmd
+            - text: "Monitoring & reporting"
+              file: faq/faq-reporting.qmd
+            - faq/faq-testing.qmd
+            - faq/faq-integrations.qmd
+            - text: "Data & privacy"
+              file: faq/faq-privacy.qmd
 
 # COMMENT THIS OUT WHEN DONE TESTING
     # - title: "Testing"

site/about/contributing/join-community.qmd

@@ -2,8 +2,8 @@
 title: ""
 # date: last-modified
 aliases:
-  - ../guide/join-community.html
-  - ../join-community.html
+  - /guide/join-community.html
+  - /about/join-community.html
 ---
 
 ```{=html}

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

@@ -286,7 +286,7 @@ For example, for an original file named `site/guide/overview.qmd` moved and rena
 ---
 title: "New overview"
 aliases:
-  - ../guide/overview.html
+  - /guide/overview.html
 ---
 ```
 :::

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

@@ -13,7 +13,7 @@ listing:
       - voice-and-tone.qmd
       - conventions.qmd
 aliases:
-  - ../../style-guide.html
+  - /about/style-guide.html
 ---
 
 A style guide helps create distinct yet unified communication across all areas of a product experience, from in-app interactions to technical documentation and blog posts. 

site/about/contributing/validmind-community.qmd

@@ -2,7 +2,7 @@
 title: "{{< var vm.product >}} community"
 date: last-modified
 aliases:
-  - ../validmind-commmunity.html
+  - /about/validmind-community.html
 ---
 
 Work with financial models, in model risk management (MRM), or are simply enthusiastic about artificial intelligence (AI) and machine learning and how these tools are actively shaping our futures within the finance industry and beyond? Congratulations — you're already part of the {{< var vm.product >}} community! Come learn and play with us. 
@@ -24,7 +24,7 @@ Learn about our company vision, get to know our brand's voice and preferred form
 
 Here at {{< var vm.product >}}, we embrace an [open source](https://en.wikipedia.org/wiki/Open_source) ideology. This means that we think expertise is inclusive, and is also open to evolving — there's always an opportunity to learn from each other, and help each other improve. 
 
-As a member of the {{< var vm.product >}} community, we invite you to be part of our process. From our public documentation to the code behind our [{{< var vm.developer >}}](/developer/get-started-validmind-library.qmd), we've exposed the wiring for inspection in hopes that great minds think differently and dare to spark change. 
+As a member of the {{< var vm.product >}} community, we invite you to be part of our process. From our public documentation to the code behind our [{{< var vm.developer >}}](/developer/validmind-library.qmd), we've exposed the wiring for inspection in hopes that great minds think differently and dare to spark change. 
 
 ### Contribution ideas
 Please note that all community contributions are subject to review by the {{< var vm.product >}} team. See our [software license agreement](/about/fine-print/license-agreement.qmd) for more details. 

site/about/fine-print/data-privacy-policy.qmd

@@ -3,8 +3,8 @@ title: "Data privacy policy"
 keywords: "data privacy, ai risk, model risk management, {{< var vm.product >}}"
 date: last-modified
 aliases:
-  - ../data-privacy-policy.html
-  - ../guide/data-privacy-policy.html
+  - /about/data-privacy-policy.html
+  - /guide/data-privacy-policy.html
 ---
 
 This page outlines {{< var vm.product >}}'s data privacy policy, explaining how we protect your personal information. 

site/about/fine-print/license-agreement.qmd

@@ -2,8 +2,8 @@
 title: "SOFTWARE LICENSE AGREEMENT"
 date: last-modified
 aliases:
-  - ../license-agreement.html
-  - ../guide/license-agreement.html
+  - /about/license-agreement.html
+  - /guide/license-agreement.html
 ---
 
 IMPORTANT: READ THIS SOFTWARE LICENSE AGREEMENT (THIS “AGREEMENT”) CAREFULLY BEFORE USING THE SOFTWARE. BY USING THE SOFTWARE, YOU ARE AGREEING TO BE BOUND BY THE TERMS OF THIS LICENSE AGREEMENT: 

site/about/glossary/key_concepts/_inputs.qmd

@@ -4,4 +4,4 @@ inputs
   - **model**: A single model that has been initialized in {{< var vm.product >}} with `vm.init_model()`. See the [Model Documentation](/validmind/validmind.html#init_model){target="_blank"} or the for more information.
   - **dataset**: Single dataset that has been initialized in {{< var vm.product >}} with `vm.init_dataset()`. See the [Dataset Documentation](/validmind/validmind.html#init_dataset){target="_blank"} for more information.
   - **models**: A list of {{< var vm.product >}} models - usually this is used when you want to compare multiple models in your custom tests.
-  - **datasets**: A list of {{< var vm.product >}} datasets - usually this is used when you want to compare multiple datasets in your custom tests. See this [example](/notebooks/how_to/run_tests_that_require_multiple_datasets.ipynb) for more information.
+  - **datasets**: A list of {{< var vm.product >}} datasets - usually this is used when you want to compare multiple datasets in your custom tests. (Learn more: [Run tests with multiple datasets(/notebooks/how_to/run_tests_that_require_multiple_datasets.ipynb)])

site/about/overview-model-documentation.qmd

@@ -2,7 +2,7 @@
 title: "Automated model testing & documentation"
 date: last-modified
 aliases:
-  - ../guide/overview-model-documentation.html
+  - /guide/overview-model-documentation.html
 listing:
   id: quickstart
   type: grid
@@ -138,7 +138,7 @@ How the {{< var validmind.developer >}} works:
 
 [^1]: [Model risk management](overview-model-risk-management.qmd)
 
-[^2]: [Supported models](/developer/model-documentation/supported-models.qmd)
+[^2]: [Supported models](/developer/supported-models.qmd)
 
 [^3]: [Customize documentation templates](/guide/model-documentation/customize-documentation-templates.qmd)
 

site/about/overview-model-risk-management.qmd

@@ -2,7 +2,7 @@
 title: "Model risk management"
 date: last-modified
 aliases:
-  - ../guide/overview-model-risk-management.html
+  - /guide/overview-model-risk-management.html
 listing:
   id: quickstart
   type: grid

site/about/overview.qmd

@@ -12,7 +12,7 @@ listing:
     - overview-model-documentation.qmd
     - overview-model-risk-management.qmd
 aliases:
-  - ../guide/overview.html
+  - /guide/overview.html
 ---
 
 :::: {.flex .flex-wrap .justify-around}