validmind · noosheenv · Jul 18, 2024 · Jul 16, 2024 · Jul 16, 2024 · Jul 16, 2024
diff --git a/site-unused/qmd/create-documentation.qmd b/site-unused/qmd/create-documentation.qmd
@@ -34,7 +34,7 @@ ValidMind has now created an empty documentation project associated with the mod

 5. Locating the project identifier, API key and secret:

-   On the **Getting started** page of the newly created project, you can find the initialization code that enables the client library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments: 
+   On the **Getting Started** page of the newly created project, you can find the initialization code that enables the client library to associate documentation and tests with the appropriate project. The initialization code configures the following arguments: 

 - `api_host`: The location of the ValidMind API
 - `api_key`: The account API key

diff --git a/site/about/contributing/style-guide/conventions.qmd b/site/about/contributing/style-guide/conventions.qmd
@@ -38,9 +38,15 @@ While the ValidMind community spans far and wide, its heart finds its home in Pa
 ### Sentence case
 In general, follow sentence-style capitalization[^3] to minimize the confusion of when to capitalize and when not to capitalize. 

+- Exceptions include referencing specific elements in the user interface (UI) that have their own casing to ensure that documentation matches the user experience, or when generating titles of publications such as blog posts.
+- For UI elements that are in all caps, use the markdown [smallcaps]{.smallcaps} class to display these elements.
+
 | Correct | Incorrect | 
 |------|-----|
 |   Get started with ValidMind  |  Get Started with ValidMind  |
+|  In the left sidebar, click **Model Inventory**.  |  In the left sidebar, click **model inventory**.  |
+|   [Honor the Human with ValidMind](https://validmind.com/honor-the-human-with-validmind/)  |  [Honor the human with ValidMind](https://validmind.com/honor-the-human-with-validmind/)  |
+|   `On the landing page of your model, locate the [model status]{.smallcaps} section:`   |  `On the landing page of your model, locate the MODEL STATUS section:`   |
 : **Sentence case** examples {.hover}

 ### Headings

diff --git a/site/developer/model-documentation/store-credentials-in-env-file.qmd b/site/developer/model-documentation/store-credentials-in-env-file.qmd
@@ -25,7 +25,7 @@ The model is already registered in the model inventory.[^1]

 2. Locate the code snippet for your model.

-   - These credentials can be found on the **Getting started** page for models registered in the model inventory. 
+   - These credentials can be found on the **Getting Started** page for models registered in the model inventory. 
   - Copy the values from this page and paste them into your `.env` file in the following format:

      ```yaml

diff --git a/site/get-started/platform/register-your-first-model.qmd b/site/get-started/platform/register-your-first-model.qmd
@@ -17,7 +17,7 @@ Signing up is FREE — **[Create your account]({{< var vm_url >}})**.

 1. Log in to the {{< var vm_login >}}.

-2. In the left sidebar, navigate to **Model Inventory** and click **+ Register new model**.[^1]
+2. In the left sidebar, navigate to **Model Inventory** and click **+ Register New Model**.[^1]

   To register a model for use with the QuickStart notebook, select:


diff --git a/site/guide/model-inventory/customize-model-inventory-layout.qmd b/site/guide/model-inventory/customize-model-inventory-layout.qmd
@@ -27,8 +27,8 @@ There are models registered in the model inventory.[^1]

 #### Inventory display views

- To display the inventory in table view, click **{{< fa table >}} Display table**. 
- To display the inventory in card view, click **Display cards**.
+- To display the inventory in table view, click **{{< fa table >}} Display Table**. 
+- To display the inventory in card view, click **Display Cards**.

 ## What's next


diff --git a/site/guide/model-inventory/register-models-in-inventory.qmd b/site/guide/model-inventory/register-models-in-inventory.qmd
@@ -17,21 +17,44 @@ To be able to document models using ValidMind's model documentation and validati
 2. Click **Model Inventory** in the left sidebar. 
 <!--- **Need screenshot** --->

-3. Click **Register new model**.
+3. Click **Register New Model**.

-4. Fill in the required information on the registration form:
+4. Depending on whether or not your organization has custom fields[^2] required on model registration, input the information on the Register New Model panel.

-   - Provide a model name
-   - Select the relevant business unit
-   - Select the relevant model methodology being used
-   - Select the relevant model use case
-   - Provide a purpose statement to explain what the model will be used for
-   - Select the preliminary risk tier for the model
-   - If the model is a vendor model, toggle **Is Vendor Model**[^2] and provide the vendor name.
+#### Basic Model Information

-5. Click **Register new model** to create a new entry in the model inventory.
+If no custom fields are required on registration for your models:

-   You can now access the model details from the **Model Inventory** page.
+1.  Provide the information outlined in the basic model information fields table below.
+
+2. Click **Register Model** to create a new entry in the model inventory.
+
+| Field | Description | 
+|---:|---|
+| Model Name | The name of your model. |
+| What type of model is it? | Whether the model is a new model, or an existing model. |
+| Template (conditional) | New models require a **Template**[^3] to be selected. |
+| Model Status (conditional) | Existing models require a **Model Status** to be selected. |
+| Business Unit | Business unit associated with the model. |
+| Use Case | The model's use case. |
+| Is it a vendor model? (optional) | If the model is a vendor model, toggle **Is Vendor Model**.[^4] |
+| Vendor Name (conditional) | If the model is a vendor model, provide the vendor's name. |
+| Purpose | Explain what the model will be used for. |
+| Preliminary Risk Tier | Assign a preliminary risk tier. |
+| Owners (optional) |  Assign another or additional model owners. |
+: **Basic model information** fields {.hover tbl-colwidths="[30,70]"}
+
+#### Additional Model Information
+
+If custom fields are required on model registration for your organization:
+
+1. First enter the [Basic Model Information](#basic-model-information), then click **Next {{< fa chevron-right >}}**.
+
+   To return to the previous panel, click **{{< fa chevron-left >}} Back**.
+
+2. Fill in your organization's required custom fields.
+
+3. Click **Register Model** to create a new entry in the model inventory.

 ## What's next

@@ -43,4 +66,8 @@ To be able to document models using ValidMind's model documentation and validati

 [^1]: [Managing users (Supported roles)](/guide/configuration/managing-users.qmd#supported-roles)

-[^2]: [Learn more about vendor models](/about/glossary/glossary.qmd#vendor-model).
+[^2]: [Manage inventory custom fields](/guide/model-inventory/manage-inventory-custom-fields.qmd)
+
+[^3]: [Working with documentation templates](/guide/model-documentation/working-with-documentation-templates.qmd)
+
+[^4]: Learn more about [vendor models](/about/glossary/glossary.qmd#vendor-model)
diff --git a/site/guide/model-workflows/working-with-model-workflows.qmd b/site/guide/model-workflows/working-with-model-workflows.qmd
@@ -32,12 +32,12 @@ To review the overall workflow status for a model:

 3. Select a model by clicking on it or find your model by applying a filter or searching for it.[^5]

-4. On the landing page of your model, locate the Model Status section: 
+4. On the landing page of your model, locate the [model status]{.smallcaps} section: 

-    - Click **{{< fa arrow-right >}} See workflow** to open the detailed workflow associated with that model.
+    - Click **{{< fa arrow-right >}} See Workflow** to open the detailed workflow associated with that model.
    - The current workflow state will be highlighted on this detail view. 

-![](see-workflow.gif){fig-alt="A gif showing the detailed workflow under the Model Status section"}
+![](see-workflow.gif){fig-alt="A gif showing the detailed workflow under the MODEL STATUS section"}

 #### See model documentation statuses


diff --git a/site/releases/2023/2023-nov-09/highlights.qmd b/site/releases/2023/2023-nov-09/highlights.qmd
@@ -102,7 +102,7 @@ We've introduced new display options for search results in the **Model Inventory
 - **Table view:** Offers a detailed, structured layout that simplifies comparison.
 - **Card view:** Provides a visual, summarized presentation.

-You can easily switch between views using the **Display table** or **Display cards** toggle next to the search results.
+You can easily switch between views using the **Display Table** or **Display Cards** toggle next to the search results.

 ## Documentation updates


diff --git a/site/releases/2024-jan-18/highlights.qmd b/site/releases/2024-jan-18/highlights.qmd
@@ -135,7 +135,7 @@ Try it in the {{< var validmind_platform >}}: [Templates]({{< var vm_url >}}/set

 <!---Cachafla/sc 2646/status updates on dashboard disappearing by @cachafla in [#513](https://github.com/validmind/frontend/pull/513)--->

-   **Disappearing status updates on dashboard**. We fixed an issue where the **Recent activity** widget would become unavailable when clicking on **Status updates**. We now show an empty state element when there is no data to show.
+-   **Disappearing status updates on dashboard**. We fixed an issue where the **Recent Activity** widget would become unavailable when clicking on **Status updates**. We now show an empty state element when there is no data to show.

 ## How to upgrade


diff --git a/site/styles.css b/site/styles.css
@@ -250,6 +250,11 @@ pre, pre.python, pre.bash, pre.yaml {
  text-underline-offset: 10px;
 }

+.smallcaps {
+  font-weight: bold;
+  font-size: larger;
+}
+
 /* section#footnotes {
  display: none !important;
 }

diff --git a/site/training/training-for-model-developers.qmd b/site/training/training-for-model-developers.qmd
@@ -255,7 +255,7 @@ Have a question? Collaborate with other developers or with your validator right
 ## {background-iframe="https://app.prod.validmind.ai" data-preload="yes"}

 :::: {.absolute bottom=15 .w-100 .f4 .tc .pl4 .pr4 .bg-near-white .ba .b--dark-pink .bw1 .br3 .near-black .shadow-5}
-In the documentation, post a comment, reply to it, and then resolve the thread. <br>Review your comments in the **Recent activity** feed on the front page. 
+In the documentation, post a comment, reply to it, and then resolve the thread. <br>Review your comments in the **Recent Activity** feed on the front page. 

 ::: {.f5 .nt2}
 When you are done, click [{{< fa chevron-right >}}]() to continue.
@@ -318,7 +318,7 @@ Track changes and updates made to model documentation over time.
 ## {background-iframe="https://app.prod.validmind.ai/" background-interactive="true" data-preload="yes"}

 :::: {.absolute bottom=15 .w-100 .f3 .tc .pl4 .bg-near-white .ba .b--dark-pink .bw1 .br3 .near-black .shadow-5}
-Review the **Recent activity** feed on the front page: 
+Review the **Recent Activity** feed on the front page: 

 :::: {.columns}
 ::: {.column width="25%" .nt2}

diff --git a/site/training/training-for-model-validators.qmd b/site/training/training-for-model-validators.qmd
@@ -171,7 +171,7 @@ Have a question about the model? Collaborate with your developer right in the mo
 ## {background-iframe="https://app.prod.validmind.ai//model-inventory" background-interactive="true" data-preload="yes"}

 :::: {.absolute bottom=15 .w-100 .f4 .tc .pl4 .pr4 .bg-near-white .ba .b--dark-pink .bw1 .br3 .near-black .shadow-5}
-In the documentation, post a comment, reply to it, and then resolve the comment thread. Review your comments in the **Recent activity** feed on the front page.
+In the documentation, post a comment, reply to it, and then resolve the comment thread. Review your comments in the **Recent Activity** feed on the front page.

 ::: {.f5 .nt2}
 When you are done, click [{{< fa chevron-right >}}]() to continue.