Skip to content

Merge main into staging #437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions site/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ website:
- text: "---"
- text: "RELEASES"
# MAKE-RELEASE-NOTES-EMBED-MARKER
- releases/2024-sep-25/release-notes.qmd
- releases/2024-sep-09/release-notes.qmd
- releases/2024-aug-13/release-notes.qmd
- releases/2024-jul-22/release-notes.qmd
Expand Down
Binary file modified site/guide/model-documentation/generate-with-ai.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 20 additions & 18 deletions site/guide/model-documentation/work-with-content-blocks.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,10 @@ The content editing toolbar is a rich text editor that enables you to:

You can also use the toolbar to suggest changes, save named versions of content, and leave comments.[^2]

::: {.content-hidden when-format="html"}

<!-- As per Nik on PR#233 (https://github.com/validmind/documentation/pull/233) we are hiding this content until we are sure we want to expose the documentation surrounding the Story to users. When it's ready to be revealed, simply remove this comment and the `.content-hidden` block it's wrapped in. -->

::: {.callout title="Stuck on where to start?"}
Use ValidMind to assist you with generating content via AI!^[[Generate with AI (BETA)](#generate-with-ai-beta)]
Use ValidMind to assist you with generating content via AI!^[[Generate with AI (BETA)](#generate-text-with-ai-beta)]
:::

:::


::: {.prereq}

## Prerequisites
Expand Down Expand Up @@ -78,31 +71,36 @@ While editing a simple text block, you can insert math equations using the edito

3. Click **Insert** to add the equation to your content block.

::: {.content-hidden when-format="html"}
### Generate Text with AI <sup>[beta]{.smallcaps}</sup>

<!-- As per Nik on PR#233 (https://github.com/validmind/documentation/pull/233) we are hiding this content until we are sure we want to expose the documentation surrounding the Story to users. When it's ready to be revealed, simply remove this comment and the `.content-hidden` block it's wrapped in. -->
While editing a simple text block, you can have ValidMind assist you with generating content drafts:

### Generate with AI (BETA)
1. Click **{{< fa diamond >}} <sup>[beta]{.smallcaps}</sup> (Generate Text with AI)** in the toolbar while editing a content block.

While editing a simple text block, you can have ValidMind assist you with generating content:
2. Enter an optional prompt to guide the output, then click **{{< fa check >}} Generate** to compose a draft for review.

1. Click **{{< fa diamond >}} BETA** in the toolbar while editing a content block.

2. The ValidMind AI Content Builder will generate a draft for your review:
3. Review the draft composed by the ValidMind AI Content Builder for accuracy and relevance, then:

- Click **{{< fa download >}} Accept Text** to insert the draft into your content block.
- Click **{{< fa rotate >}} Try Again** to regenerate a different draft.
- Click **Cancel** to discard the draft and return to your documentation section.

![Generating content with AI within a simple text block](generate-with-ai.gif){width=100% fig-alt="An animation that showcases the Generate with AI feature within a simple text block" class="screenshot"}
4. After you insert the AI-generated draft, click on the text box to make the necessary edits and adjustments to your copy:

- Ensure that content is in compliance with the quality guidelines outlined by your organization.
- Use the content editing toolbar[^7] just as you would with any other text block.

![Generating content with AI within a simple text block](generate-with-ai.gif){width=100% fig-alt="An animation that showcases the Generate with AI feature within a simple text block"}

::: {.callout}
When generating content drafts with AI, accepted versions and edits are retained in your Model Activity[^8] just like other updates to your documentation, reports, or plans.
:::

## Remove content blocks

1. In the left sidebar, click **Model Inventory**.

2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^7]
2. Select a model by clicking on it or find your model by applying a filter or searching for it.[^9]

3. In the left sidebar that appears for your model, click **Documentation**, **Validation Report**, or **Ongoing Monitoring**.

Expand Down Expand Up @@ -149,4 +147,8 @@ While editing a simple text block, you can have ValidMind assist you with genera

[^6]: [Collaborate with others](/guide/model-documentation/collaborate-with-others.qmd)

[^7]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
[^7]: [Content editing toolbar](#content-editing-toolbar)

[^8]: [View model activity](/guide/model-inventory/view-model-activity.qmd)

[^9]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)
1 change: 1 addition & 0 deletions site/releases/2024-releases.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ listing:
# WITH CTAS >250 CHARS
# SEE `releases/2023/2023-releases.qmd` SECTION FOR EXAMPLE
contents:
- 2024-sep-25/release-notes.qmd
- 2024-sep-09/release-notes.qmd
- 2024-aug-13/release-notes.qmd
- 2024-jul-22/release-notes.qmd
Expand Down
Binary file added site/releases/2024-sep-25/ai-content-builder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/releases/2024-sep-25/generate-ai-prompt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/releases/2024-sep-25/generate-with-ai.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions site/releases/2024-sep-25/release-notes.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "September 25, 2024"
filters:
- tachyons
---

## Release highlights

Our new and improved our AI-generation feature enables you to more easily draft content within your model documentation, validation reports, and ongoing monitoring plans right in the {{< var validmind.platform >}}.

<!---
PR #696: Added "Generate with AI" button to the CKEditor
URL: https://github.com/validmind/frontend/pull/696
Labels: enhancement, highlight
--->

### Generate with ValidMind AI

![](generate-with-ai.png){width="80%" fig-alt="A screenshot showing the content editing toolbar with the Generate with AI button on the right"}

:::: {.flex .flex-wrap .justify-around}

::: {.w-50-ns}
Our new **{{< fa diamond >}} <sup>[beta]{.smallcaps}</sup> (Generate Text with AI)** button is now available when you edit simple text blocks in model documentation, model validation reports, and ongoing monitoring plans. This button replaces the old button that was used to AI-generate content.

- Provide an optional prompt to guide the output, then click **{{< fa check >}} Generate** to compose a draft for review.
- You can choose to **{{< fa download >}} Accept Text** to insert the draft into your text block, or **{{< fa rotate >}} Try Again** to regenerate a different copy.

![](generate-ai-prompt.png){width=90% fig-alt="A screenshot showing the ValidMind AI Content Builder modal with the optional prompt box"}

<form method="get" action="/guide/model-documentation/work-with-content-blocks.html#generate-text-with-ai-beta" target="_blank">
<button type="submit" style="color: white; background-color: #de257e; border-radius: 8px; border: none; font-size: 16px; padding: 6.25px 12.5px; margin-left: 16px; margin-bottom: 20px;">Work with content blocks</button>
</form>

:::

::: {.w-50-ns}

![](ai-content-builder.png){width="80%" fig-alt="A screenshot showing a modal with AI-generated text"}

:::

::::