Skip to content

Commit e11ad9d

Browse files
authored
Merge pull request #10939 from mendix/yl-Maia-documentation-update-11-9
Maia Documentation Updates for 11.9
2 parents 4e0b467 + 562049f commit e11ad9d

12 files changed

Lines changed: 85 additions & 64 deletions

File tree

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

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,7 @@ Mendix AI Assistance (Maia) in Studio Pro has the following capabilities:
3939
Starting point for app creation:
4040

4141
* **Start with Maia** - a starting point in Studio Pro that helps you to start the app development process. Based on a required text description and an optional image or PDF, it generates an app that includes a domain model, data management overview pages, test data, and a tailored homepage. For more information, see [Start with Maia](/refguide/start-with-maia/).
42-
* **Maia Make** - a unified conversational interface in Studio Pro that groups all AI-assisted development capabilities into a single chat experience. With this interface, everything happens in one place. Start a conversation, describe what you need, and Maia generates the necessary app artifacts—a new domain model, overview pages, or microflows, or explaining your app logic and pages. Below is a list of Maia Make Capabilities:
43-
44-
* **Domain model creation** - Describe your data structure and Maia creates the entities and associations you need.
45-
* **Page generation** - Generate overview pages.
46-
* **Microflow generation** - Generate microflows, enumerations, XPath constraints, and expressions.
47-
* **MCP client** - Connect to compatible MCP Servers to leverage tools such as Playwright or Figma to improve the capabilities of Maia.
48-
* **Document upload** - Upload a PDF or an image and you can ask Maia to use it in your app creation.
49-
* **User story linking** - Select an existing story in Studio Pro and Maia can help you realize it.
42+
* **Maia Make** - a unified conversational interface in Studio Pro that groups all AI-assisted development capabilities into a single chat experience. With this interface, everything happens in one place. Start a conversation, describe what you need, and Maia generates the necessary app artifacts, such as a new domain model, pages, and microflows. You can also ask it to explain documents for you, including your app logic and pages.
5043

5144
This unified conversational interface is released in Studio Pro 11.8. For more information, see [Maia Make](/refguide/maia-make/).
5245

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

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,28 @@ Maia Make capabilities are grouped into a conversational interface, which is ava
1515
To use this interface and Maia Make capabilities, an internet connection and signing in to Studio Pro are required.
1616
{{% /alert %}}
1717

18-
Maia Make is a set of AI-assisted development capabilities in Studio Pro that are available through a unified conversational interface. Describe your requirements in natural language, and Maia generates development artifacts such as data structures, overview pages, and microflows.
18+
Maia Make is a set of AI-assisted development capabilities in Studio Pro that are available through a unified conversational interface. Describe your requirements in natural language, and Maia generates development artifacts such as data structures, pages, and microflows.
1919

20-
You can also ask Maia to provide explanations of your existing logic and pages. Moreover, this interface allows you to integrate with external tools via MCP Servers (Playwright, Figma, and others) and it supports story-based development by generating app artifacts based on existing user stories.
20+
You can also ask Maia to provide explanations of your existing documents, such as microflows, workflows, and pages. Moreover, this interface allows you to integrate with external tools, such as Playwright and Figma, via MCP Servers, and it supports story-based development by generating app artifacts based on existing user stories.
2121

2222
The key Maia Make capabilities are as follows:
2323

2424
* Conversational assistance for general Mendix development queries
25-
* Logic and page explanations to clarify existing implementation details
26-
* Domain model generation from natural language descriptions
27-
* Overview page generation from natural language descriptions
28-
* Microflow generation including XPath constraints and expressions
29-
* External tool integration via compatible MCP Servers (such as Playwright, Figma)
25+
* Explanations of documents to clarify existing implementation details
26+
* Generation of documents from natural language descriptions, such as domain model, pages, and microflows
27+
* Integration with external tools, such as Playwright and Figma, via compatible MCP Servers
3028
* Story-based development to help realize existing user stories
31-
* PDF and image support to help Maia understand your requirements better
32-
* Add relevant logic and pages to the interface to give Maia a more desired context
29+
* Support for PDF and image inputs to help Maia better understand your requirements
30+
* Adding relevant documents, such as microflows and pages, to the interface to give Maia a more desired context
31+
* Editing existing documents, including renaming elements inside of documents such as entities, attributes, and microflow parameters
32+
* Removing elements from documents, enabling more advanced refactoring (in Studio Pro 11.9 and above)
33+
* Undoing changes generated on a per-document basis (in Studio Pro 11.9 and above)
34+
35+
{{% alert color="info" %}}
36+
Support for workflows, view entities, enumerations, constants, modules, Java actions, and JavaScript actions was introduced in Studio Pro 11.9.
37+
38+
Java actions and JavaScript actions are read-only. Java actions can be used in microflows and can be explained. JavaScript actions can only be explained.
39+
{{% /alert %}}
3340

3441
## Using Maia Make Capabilities
3542

@@ -67,9 +74,11 @@ For more information on how each Maia Make capability work, refer to the followi
6774
* [Maia for Domain Model](/refguide/maia-for-domain-model/)
6875
* [Maia for Pages](/refguide/maia-for-pages/)
6976
* [Maia for Microflows](/refguide/maia-for-microflows/)
77+
* [Maia for Workflows](/refguide/maia-for-workflows/) (in Studio Pro 11.9 and above)
78+
* [[Maia for OQL](/refguide/maia-for-oql/)] (in Studio Pro 11.9 and above)
7079
* [Maia MCP Client](/refguide/maia-mcp/)
7180

72-
In Studio Pro 11.8 and above, most of the features described in the documents above are available only through the chat interface. There are no separate entry points to these features in their respective editors. [Maia Explain](/refguide/maia-explain/) is an exception. You can still access this feature by right-clicking the documents (microflows or pages) in the **App Explorer** and the **Maia Explain** option is in the context menu.
81+
In Studio Pro 11.8 and above, most of the features described in the documents above are available only through the chat interface. There are no separate entry points to these features in their respective editors. [Maia Explain](/refguide/maia-explain/) is an exception. You can still access this feature by right-clicking the documents (for example, microflows or pages) in the **App Explorer** and the **Maia Explain** option is in the context menu.
7382

7483
## Read More
7584

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

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,14 @@ See below a list of Maia Chat's data sources:
3333
* [Mendix Blog](https://www.mendix.com/blog/)
3434
* [Mendix Medium](https://medium.com/mendix)
3535
* [Mendix Evaluation Guide](https://www.mendix.com/evaluation-guide/)
36-
37-
## Using Maia Chat in Studio Pro
3836

39-
{{% alert color="info" %}}
37+
## Using Maia Chat
38+
39+
### In Studio Pro 11.8 and Above
40+
4041
In Studio Pro 11.8 and above, Maia Chat is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia Chat. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
41-
{{% /alert %}}
42+
43+
### In Studio Pro 11.7 and Below
4244

4345
In Studio Pro 11.7 and below, there are two ways to access Maia Chat in Studio Pro:
4446

@@ -55,7 +57,7 @@ For more information on Maia Chat features in Studio Pro, see the sub-sections b
5557

5658
If Maia is not giving you a good answer, check the [best practices](/portal/maia/#best-practices) in *Maia in Mendix Portal*. If you still can not get a good answer, please see the [Giving Feedback](#feedback) section below for information on how to let Mendix know.
5759

58-
### Maia Chat Features in Studio Pro
60+
#### Maia Chat Features in Studio Pro
5961

6062
After a question is sent to Maia Chat, you will see the following in the chat interface:
6163

@@ -67,7 +69,7 @@ After a question is sent to Maia Chat, you will see the following in the chat in
6769
* A copy icon ({{% icon name="copy" %}}) which allows you to copy the given answer to a clipboard
6870
* Feedback icons
6971

70-
#### Giving Feedback {#feedback}
72+
##### Giving Feedback {#feedback}
7173

7274
Mendix encourages giving feedback on the answers generated by Maia Chat. Feedback will be used to further improve Maia Chat.
7375

@@ -82,15 +84,15 @@ There are several ways to give feedback on the generated answer:
8284
* You can also provide **Additional feedback** if you want to.
8385
* Remember to click **Submit feedback** to submit your feedback. Afterwards, you will be brought back to the main chat interface where you can continue asking questions.
8486

85-
#### Asking Follow-Up Questions
87+
##### Asking Follow-Up Questions
8688

8789
Maia Chat supports asking follow-up questions based on your previous question and the answer you have received. For example, you can ask it to summarize the latest answer you received by typing the following in the chat: *Can you summarize that?*.
8890

8991
{{% alert color="info" %}}
9092
Maia Chat will lose track of the conversation history if you exit Studio Pro.
9193
{{% /alert %}}
9294

93-
#### New Chat
95+
##### New Chat
9496

9597
There is a **New chat** option at the top left of the chat interface. It allows you to clear the messages and start a new conversation which does not reference your current chat.
9698

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

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,20 @@ description: "Describes the features in Maia Explain."
1212
To use Maia Explain, an internet connection and signing in to Studio Pro are required.
1313
{{% /alert %}}
1414

15-
## Using Maia Explain in Studio Pro 11.8 and Above
15+
## Using Maia Explain
16+
17+
### In Studio Pro 11.8 and Above
1618

1719
In Studio Pro 11.8 and above, Maia Explain is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia Explain. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
1820

1921
There are two ways to use Maia Explain:
2022

21-
* Use the chat interface directly to get explanations of your microflows or pages.
22-
* In the App Explorer, right-click a microflow or a page to open its context menu, and click **Maia Explain**.
23+
* Use the chat interface directly to get explanations of your document (for instance, a microflow or a page).
24+
* In the App Explorer, right-click a document to open its context menu, and click **Maia Explain**.
2325

24-
Nanoflows are not supported by Maia Explain in Studio Pro 11.8.
26+
Nanoflows are currently not supported by Maia Make.
2527

26-
## Using Maia Explain in Studio Pro 11.7 and Below
28+
### In Studio Pro 11.7 and Below
2729

2830
In Studio Pro 11.7 and below, Maia Explain is enabled by default. If you want to disable this feature, go to **Edit** > **Preferences** > the **Maia** tab and clear the **Enable Maia Explain** checkbox.
2931

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

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,11 @@ Maia for Domain Model helps you generate new [domain model](/refguide/domain-mod
1818

1919
## Using Maia for Domain Model
2020

21-
{{% alert color="info" %}}
21+
### In Studio Pro 11.8 and Above
22+
2223
In Studio Pro 11.8 and above, Maia for Domain Model is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia for Domain Model. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
23-
{{% /alert %}}
24+
25+
### In Studio Pro 11.7 and Below
2426

2527
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:
2628

@@ -44,7 +46,7 @@ Maia for Domain Model does not support deleting items in the domain model. You c
4446
In this dedicated chat, only requests related to domain model will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface.
4547
{{% /alert %}}
4648

47-
### Best Practices for Text Input
49+
#### Best Practices for Text Input
4850

4951
To achieve optimal results, provide context about your application by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your application, the more tailored and accurate the generated domain model will be.
5052

@@ -64,7 +66,7 @@ Below are examples of prompts you can use to ask Maia for explanations or sugges
6466
* I want to make the domain model more efficient. Can you suggest optimizations?
6567
* Could you identify any potential issues with this domain model and recommend solutions?
6668

67-
### Attachment Requirements {#attachment-requirements}
69+
#### Attachment Requirements {#attachment-requirements}
6870

6971
In Studio Pro 11.1 and above, Maia for Domain Model supports adding a maximal of one image and one PDF as attachments. The attachments must meet the following requirements:
7072

@@ -73,17 +75,12 @@ In Studio Pro 11.1 and above, Maia for Domain Model supports adding a maximal of
7375
* The image resolution must be no greater than 3840 × 2400 pixels.
7476
* The PDF file size must not exceed 1024 KB.
7577

76-
## Limitations {#limitation}
77-
78-
Maia for Domain Model has some limitations.
79-
80-
### Enumeration Generation
81-
82-
It can only generate an attribute of type Enumeration if there is an existing enumeration in the module to refer to.
78+
#### Limitations {#limitation}
8379

84-
### Generalization Not Supported
80+
Maia for Domain Model has the following limitations:
8581

86-
It cannot set [generalization](/refguide/generalization-and-association/) for an entity.
82+
* It can only generate an attribute of type Enumeration if there is an existing enumeration in the module to refer to.
83+
* It cannot set [generalization](/refguide/generalization-and-association/) for an entity.
8784

8885
## Read More
8986

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

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Maia for OQL"
33
url: /refguide/maia-for-oql/
4-
weight: 70
4+
weight: 78
55
description: "Describes the features in Maia for OQL Generation."
66
---
77

@@ -15,15 +15,21 @@ Maia for OQL is a powerful feature that enables you to generate and manage OQL (
1515

1616
## Using Maia for OQL
1717

18-
To enable this feature, navigate to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for OQL Generation**.
18+
### In Studio Pro 11.9 and Above
19+
20+
In Studio Pro 11.9 and above, Maia for OQL is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia for OQL. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
21+
22+
### In Studio Pro 11.8 and Below
23+
24+
In Studio Pro 11.8 and below, to enable Maia for OQL, navigate to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for OQL Generation**.
1925

2026
Once enabled, you can access it from the toolbar in the **OQL Editor**:
2127

22-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-oql-generator/maia-for-oql-button.png" max-width=80% >}}
28+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-oql-generator/maia-for-oql-button.png" max-width=80% >}}
2329

2430
Clicking **Maia for OQL** opens a dedicated chat interface on the right side of Studio Pro, under the **Maia** tab:
2531

26-
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-oql-generator/maia-pane-for-oql-generator.png" max-width=42% >}}
32+
{{< figure src="/attachments/refguide/modeling/mendix-ai-assistance/maia-make/maia-oql-generator/maia-pane-for-oql-generator.png" max-width=42% >}}
2733

2834
To use Maia for OQL, simply describe the data you need. For example, if you type *Show all active orders with customer names*, Maia will generate the most relevant OQL query based on the data available in the same module.
2935

content/en/docs/refguide/modeling/mendix-ai-assistance/maia-make/maia-for-pages.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,15 @@ Maia for Pages helps you generate a [page](/refguide/page/) by adding and config
1818

1919
## Using Maia for Pages
2020

21-
{{% alert color="info" %}}
21+
### In Studio Pro 11.8 and Above
22+
2223
In Studio Pro 11.8 and above, Maia for Pages is incorporated into the unified Maia Make capabilities, which are enabled by default. There is no dedicated interface only for Maia for Pages. For more information, see [Maia Make Capabilities](/refguide/maia-make/).
23-
{{% /alert %}}
24+
25+
In Studio Pro 11.8, only overview pages can be generated.
26+
27+
In Studio Pro 11.9 and above, custom pages can be generated from scratch and modifying existing pages is also supported. Moreover, local variables, additional data sources, client actions, XPath constraints, and expressions are supported.
28+
29+
### In Studio Pro 11.7 and Below
2430

2531
In Studio Pro 11.7 and below, to enable Maia for Pages, go to **Edit** > **Preferences** > the **Maia** tab and select **Enable Maia for Pages**.
2632

@@ -46,7 +52,7 @@ On pages that have already been created, either by Maia for Pages or manually, y
4652
In this dedicated chat, only requests related to Pages will be properly handled. If you have other questions, close this chat and go back to the general [Maia Chat](/refguide/maia-chat/) interface.
4753
{{% /alert %}}
4854

49-
### Best Practices for Text Input
55+
#### Best Practices for Text Input
5056

5157
To achieve optimal results, provide context about your page by describing its main use cases, customer needs, or other relevant details. The more Maia knows about your page, the more tailored and accurate the generated page will be.
5258

@@ -68,13 +74,13 @@ Below are examples of prompts you can use to ask Maia to make further edits or r
6874
* How can I make this page more user-friendly or visually appealing?
6975
* Could you suggest ways to optimize the performance of this page?
7076

71-
### Best Practices for Image Input
77+
#### Best Practices for Image Input
7278

7379
The image size is limited to 512 KB. Make sure to select a clear image to help Maia better understand your request. For example, you can provide a screenshot, a photo, a design mock-up, or a close-up picture of a drawing. Avoid heavily compressed or low quality images, as these may result in the loss of important details.
7480

7581
Keep in mind that Maia analyzes only the structure of the image. The theming of your app, such as the color scheme, will not be changed. This can cause some differences between the provided image and the generated page.
7682

77-
## Limitation {#limitation}
83+
### Limitation {#limitation}
7884

7985
Maia for Pages does not support all widgets.
8086

0 commit comments

Comments
 (0)