Skip to content

Commit babb381

Browse files
authored
Merge pull request #11180 from mendix/yl-move-maia-docs-under-refguide
Move Maia docs directly under Studio Pro 11 Guide
2 parents e16aa05 + fde55ae commit babb381

72 files changed

Lines changed: 45 additions & 45 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/en/docs/refguide/modeling/mendix-ai-assistance/_index.md renamed to content/en/docs/refguide/mendix-ai-assistance/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Mendix AI Assistance (Maia)"
33
url: /refguide/mendix-ai-assistance/
4-
weight: 45
4+
weight: 17
55
description: "Describes Mendix AI Assistance (Maia) in Studio Pro."
66
aliases:
77
- /refguide/mx-assist-studio-pro/

content/en/docs/refguide/modeling/mendix-ai-assistance/best-practice-recommender/_index.md renamed to content/en/docs/refguide/mendix-ai-assistance/best-practice-recommender/_index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Best Practice Recommender is enabled by default and is designed as a pane. To ac
3232

3333
The pane gives you information on each anti-pattern and contains Best Practice Recommender settings and configurations:
3434

35-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/best-practice-recommender-pane.png" alt="Best Practice Recommender Pane" class="no-border" >}}
35+
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/best-practice-recommender-pane.png" alt="Best Practice Recommender Pane" class="no-border" >}}
3636

3737
### Options and Configuration {#options}
3838

@@ -46,11 +46,11 @@ At the top of the **Best Practice Recommender** pane, you can see the following
4646

4747
* The **App Model** tab lists all relevant documents in your app. You can choose which specific modules or documents to inspect or leave out.
4848

49-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/app-model.png" alt="App Model" width="300px" >}}
49+
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/app-model.png" alt="App Model" width="300px" >}}
5050

5151
* The **Best Practice** tab lists the available best practice. You can choose your preferred best practices and inspect your model against it:
5252

53-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/best-practice.png" alt="Best Practice" width="400px" >}}
53+
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/best-practice.png" alt="Best Practice" width="400px" >}}
5454

5555
You can use both app model and best practice configuration together.
5656

@@ -69,7 +69,7 @@ Each anti-pattern line in the pane provides you with the following information:
6969

7070
Right-clicking the message line of an anti-pattern in the pane opens the drop-down menu:
7171

72-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/drop-down-menu.jpg" alt="Drop-Down Menu" class="no-border" >}}
72+
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/drop-down-menu.jpg" alt="Drop-Down Menu" class="no-border" >}}
7373

7474
The following actions are available in the drop-down menu:
7575

@@ -93,7 +93,7 @@ The **Inspect now** option will be disabled if there are consistency errors in t
9393

9494
The recommender will detect anti-patterns and list them in the pane under the associated anti-pattern type. To learn more about each anti-pattern type, click the anti-pattern code link. Click the arrow icon next to the anti-pattern type to see the detected cases of this type:
9595

96-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/viewing-anti-pattern.jpg" alt="Viewing Anti-Pattern" class="no-border" >}}
96+
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/viewing-anti-pattern.jpg" alt="Viewing Anti-Pattern" class="no-border" >}}
9797

9898
To view the element or the document where the anti-pattern is located, double-click the message line or right-click the message line and choose **Go to Cause** or **Go to Usage** in the drop-down menu.
9999

@@ -110,24 +110,24 @@ There are two ways to view the recommendations:
110110
1. Right-click an anti-pattern message on the pane and select **View Best Practice recommendation** in the drop-down menu.
111111
2. Click an indicator in the visual editor to view the detected issue:
112112

113-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/indicator-in-editor.jpg" alt="Indicator in the Editor" width="450px" class="no-border" >}}
113+
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/indicator-in-editor.jpg" alt="Indicator in the Editor" width="450px" class="no-border" >}}
114114

115115
The recommendation contains the description of the identified issue, potential impact from it, the way to fix it, and a link to a more detailed guidance on fixing the issue:
116116

117-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/best-practice-recommendation.png" alt="Best Practice Recommendation" width="500px" >}}
117+
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/best-practice-recommendation.png" alt="Best Practice Recommendation" width="500px" >}}
118118

119119
### Auto-Fixing the Anti-Pattern {#auto-fixing}
120120

121121
The third level of assistance is **auto-fixing** where the recommender can automatically implement the best practice and fix the issue in just one click. To avoid undesirable changes, auto-fixing is only available when the recommender can safely refactor the code without creating an error or making other undesirable change in the model. Each anti-pattern has an icon in the pane that indicates whether it is auto-fixable. If the icon has the “A” letter, the issue can be auto-fixed:
122122

123-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/auto-fixable.png" alt="Auto-Fixable Icon" width="45" class="no-border" >}}
123+
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/auto-fixable.png" alt="Auto-Fixable Icon" width="45" class="no-border" >}}
124124

125125
To auto-fix the issue, follow the steps below:
126126

127127
1. Click the corresponding indicator in the editor to open the recommendation or right-click the message line in the pane and select **View Best Practice recommendation** in the drop-down menu.
128128
2. In the **Recommendation from Best Practice Recommender** pop-up window, click **Fix**:
129129

130-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/best-practice-recommender/fix-issue.png" alt="Fix Issue" width="500px" >}}
130+
{{< figure src="/attachments/refguide/mendix-ai-assistance/best-practice-recommender/fix-issue.png" alt="Fix Issue" width="500px" >}}
131131

132132
After the issue is auto-fixed, a pop-up window listing the changes appears. You can click **Show the fix** to view the changed document and element.
133133

content/en/docs/refguide/modeling/mendix-ai-assistance/best-practice-recommender/performance-best-practices.md renamed to content/en/docs/refguide/mendix-ai-assistance/best-practice-recommender/performance-best-practices.md

File renamed without changes.

content/en/docs/refguide/modeling/mendix-ai-assistance/logic-recommender.md renamed to content/en/docs/refguide/mendix-ai-assistance/logic-recommender.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,29 +34,29 @@ Logic Recommender is enabled by default. You can disable it via **Edit** > **Pre
3434

3535
Logic Recommender is displayed as a blue plus in the flow. When you want to view recommendations on a particular flow, you can hover the mouse over that flow and click on the blue plus, or navigate to it with the keyboard and press <kbd>Enter</kbd>.
3636

37-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/logic-recommender/assist-bulb.png" max-width=50% >}}
37+
{{< figure src="/attachments/refguide/mendix-ai-assistance/logic-recommender/assist-bulb.png" max-width=50% >}}
3838

3939
{{% alert color="info" %}}
4040
If the sequence flow is too short or is selected, the blue plus is hidden. To open Logic Recommender in such cases, right-click the flow to open its context menu, and click **Open recommender**.
4141
{{% /alert %}}
4242

4343
A dialog box is shown with recommendations of objects or activities to insert. This list initially contains the top 10 contextual suggestions. You can select an element directly from the recommendation list:
4444

45-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/logic-recommender/initial-recommendations.png" max-width=80% >}}
45+
{{< figure src="/attachments/refguide/mendix-ai-assistance/logic-recommender/initial-recommendations.png" max-width=80% >}}
4646

4747
You can also type in the search box to search for the elements that you want to add to the flow. Logic Recommender works with fuzzy search, which means that it finds direct matches first and then any matches in the recommendations. For instance, you can use `cr ob` to search for the recommendations that contain **Create Object**.
4848

4949
The search is based on your microflow or nanoflow parameters, domain model entities, or the documents in your app. You can search for generic activities or elements from the toolbox:
5050

51-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/logic-recommender/search-toolbox.png" max-width=80% >}}
51+
{{< figure src="/attachments/refguide/mendix-ai-assistance/logic-recommender/search-toolbox.png" max-width=80% >}}
5252

5353
You can search for sub-actions of an aggregate list or list operation activity, such as sum, count, or average:
5454

55-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/logic-recommender/search-sub-actions.png" max-width=100% >}}
55+
{{< figure src="/attachments/refguide/mendix-ai-assistance/logic-recommender/search-sub-actions.png" max-width=100% >}}
5656

5757
You can also use the search to call microflows or nanoflows with a concrete document:
5858

59-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/logic-recommender/search-sub-flows.png" max-width=80% >}}
59+
{{< figure src="/attachments/refguide/mendix-ai-assistance/logic-recommender/search-sub-flows.png" max-width=80% >}}
6060

6161
Choose a suggestion and click it to accept it. You can also choose a suggestion with the arrow keys and press the <kbd>Enter</kbd> key to accept it. The suggested element will be added to the flow and the Recommender will open on the next flow so that you can continue adding activities.
6262

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-learn.md renamed to content/en/docs/refguide/mendix-ai-assistance/maia-learn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ There are two ways to access Maia Learn:
2323

2424
The learning interface appears at the right side of Studio Pro under the **Maia** tab:
2525

26-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-learn/maia-learn-interface.png" width="300px">}}
26+
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-learn/maia-learn-interface.png" width="300px">}}
2727

2828
Click **Mendix Core Concepts**, you can start your learning journey with Maia Learn and learn all the basics about domain models, pages, logic, security, and integrations, including how you can apply these core concepts in Studio Pro.
2929

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/_index.md renamed to content/en/docs/refguide/mendix-ai-assistance/maia-make/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Maia Make capabilities are enabled by default. You can disable them in Studio Pr
4444

4545
To access the conversational interface and Maia Make capabilities, in the upper-right corner of Studio Pro, click the **Maia** pane. It appears under the **Chat** tab:
4646

47-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-make-interface.png" max-width=40% alt="Maia Make interface" >}}
47+
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-make-interface.png" max-width=40% alt="Maia Make interface" >}}
4848

4949
Alternatively, you can also click **View** at the Studio Pro top bar and select **Maia** to open the interface.
5050

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-chat.md renamed to content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-chat.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ In Studio Pro 11.7 and below, there are two ways to access Maia Chat in Studio P
5050

5151
The chat interface appears at the right side of Studio Pro under the **Maia** pane:
5252

53-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-chat/maia-chat-interface.png" width="250px">}}
53+
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/maia-chat-interface.png" width="250px">}}
5454

5555
You can start using Maia Chat by clicking one of the demo questions. Alternatively, you can ask your own question, and press <kbd>Enter</kbd> or click **Ask** to send the question. For information on the supported shortcut keys in Maia Chat, see the [Maia Chat Shortcut Keys](/refguide/keyboard-shortcuts/#maia-chat-shortcuts) section in *Keyboard Shortcuts*.
5656

@@ -79,7 +79,7 @@ There are several ways to give feedback on the generated answer:
7979
* Click the thumbs up icon ({{% icon name="thumbs-up" %}}) or the thumbs down icon ({{% icon name="thumbs-down" %}})
8080
* To provide more detailed feedback, click the add feedback icon ({{% icon name="notes-paper-edit" %}}). A detailed **Feedback** section shows below the answer:
8181

82-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-chat/feedback-section.png" width="250px" >}}
82+
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-chat/feedback-section.png" width="250px" >}}
8383

8484
* You can rate the **correctness**, **completeness**, and **readability** of the provided answer.
8585
* You can also provide **Additional feedback** if you want to.

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-explain.md renamed to content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-explain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ There are two ways to use Maia Explain:
3636

3737
A message is sent to Maia and a chat interface with an initial answer appears on the right side of Studio Pro under the **Maia** tab:
3838

39-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-explain/maia-explain-interface.png" width="300px">}}
39+
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-explain/maia-explain-interface.png" width="300px">}}
4040

4141
The initial answer consists of two parts:
4242

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-domain-model.md renamed to content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,13 @@ In Studio Pro 11.8 and above, Maia for Domain Model is incorporated into the uni
2626

2727
In Studio Pro 11.7 and below, Maia for Domain Model is enabled by default. You can find it in the the toolbar of a domain model:
2828

29-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-domain-model/maia-for-domain-model.png" max-width=80% >}}
29+
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model/maia-for-domain-model.png" max-width=80% >}}
3030

3131
If you want to disable this feature, go to **Edit** > **Preferences** > the **Maia** tab and clear the **Enable Maia for Domain Model** checkbox.
3232

3333
After clicking **Maia for Domain Model**, a dedicated chat interface will appear at the right side of Studio Pro under the **Maia** tab:
3434

35-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-domain-model/chat-interface.png" max-width=42% >}}
35+
{{< figure src="/attachments/refguide/mendix-ai-assistance/maia-make/maia-for-domain-model/chat-interface.png" max-width=42% >}}
3636

3737
Describe your application or its main goals in the chat. Maia will use this information to generate a relevant domain model for you. In Studio Pro 11.1 and above, you can also attach maximally one image and one PDF to help Maia better understand your request. For more information, see the [Attachment Requirements](#attachment-requirements) section below.
3838

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-microflows.md renamed to content/en/docs/refguide/mendix-ai-assistance/maia-make/maia-for-microflows.md

File renamed without changes.

0 commit comments

Comments
 (0)