Skip to content

Commit c851953

Browse files
committed
Reviewed and added a note to the Maia for Pages documentation
1 parent 6603ff5 commit c851953

2 files changed

Lines changed: 27 additions & 23 deletions

File tree

  • content/en/docs

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/_index.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ This section is represented by the `properties` tag in the widget XML file. It d
250250
</properties>
251251
```
252252

253-
### How to Enhance Your Pluggable Widget for Maia by Using `<prompt>`
253+
### How to Enhance Your Pluggable Widget for Maia by Using `<prompt>` {#using-prompt-for-maia}
254254

255255
Maia can help developers and users work more effectively with pluggable widgets when it understands their purpose and configuration options. To enable this, you can enhance your widget definition XML file with prompt elements that describe your widget's functionality in natural language.
256256

@@ -294,46 +294,46 @@ Well-written prompts help Maia provide accurate and helpful assistance to develo
294294

295295
#### Guidelines for Widget Prompts
296296

297-
- **Be concise and action-oriented**: Start with an action verb and keep the prompt under 20 words when possible
298-
- **Focus on use cases**: Describe when and why someone would use this widget
299-
- **Use plain language**: Avoid technical jargon
300-
- **Be specific**: Instead of "displays data," write "displays tabular data with sorting and filtering capabilities"
297+
* **Be concise and action-oriented**: Start with an action verb and keep the prompt under 20 words when possible
298+
* **Focus on use cases**: Describe when and why someone would use this widget
299+
* **Use plain language**: Avoid technical jargon
300+
* **Be specific**: Instead of "displays data," write "displays tabular data with sorting and filtering capabilities"
301301

302302
**Good examples:**
303303

304-
- `"Add a data grid widget to display tabular data with sorting and pagination."`
305-
- `"Create a progress bar to show task completion status."`
306-
- `"Insert a chart widget to visualize numerical data as graphs."`
304+
* `"Add a data grid widget to display tabular data with sorting and pagination."`
305+
* `"Create a progress bar to show task completion status."`
306+
* `"Insert a chart widget to visualize numerical data as graphs."`
307307

308308
**Poor examples:**
309309

310-
- `"Widget for data"` (too vague)
311-
- `"Implements advanced data visualization paradigms using reactive patterns"` (too technical)
310+
* `"Widget for data"` (too vague)
311+
* `"Implements advanced data visualization paradigms using reactive patterns"` (too technical)
312312

313313
#### Guidelines for Property Prompts
314314

315-
- **Explain the impact**: Describe how the property affects the widget's behavior or appearance
316-
- **Mention key values**: If the property has important values or ranges, include them
317-
- **Use present tense**: Write as if describing current behavior, not future actions
318-
- **Be specific about relationships**: If a property depends on others, mention that relationship
315+
* **Explain the impact**: Describe how the property affects the widget's behavior or appearance
316+
* **Mention key values**: If the property has important values or ranges, include them
317+
* **Use present tense**: Write as if describing current behavior, not future actions
318+
* **Be specific about relationships**: If a property depends on others, mention that relationship
319319

320320
**Good examples:**
321321

322-
- `"Determines whether users can select single or multiple rows in the table."`
323-
- `"Sets the refresh interval in seconds; 0 disables automatic refresh."`
324-
- `"Controls the color of the progress bar using CSS color values."`
322+
* `"Determines whether users can select single or multiple rows in the table."`
323+
* `"Sets the refresh interval in seconds; 0 disables automatic refresh."`
324+
* `"Controls the color of the progress bar using CSS color values."`
325325

326326
**Poor examples:**
327327

328-
- `"Selection stuff"` (too vague)
329-
- `"Will configure selection"` (wrong tense)
330-
- `"Property for selection configuration management"` (too wordy)
328+
* `"Selection stuff"` (too vague)
329+
* `"Will configure selection"` (wrong tense)
330+
* `"Property for selection configuration management"` (too wordy)
331331

332332
#### General Writing Guidelines
333333

334-
- **Use consistent terminology**: Match the language used in Mendix documentation and Studio Pro
335-
- **Avoid redundancy**: Don't repeat information already clear from the caption
336-
- **Keep it updated**: Update prompts when widget functionality changes
334+
* **Use consistent terminology**: Match the language used in Mendix documentation and Studio Pro
335+
* **Avoid redundancy**: Do not repeat information that is already clear from the caption
336+
* **Keep it updated**: Update prompts when widget functionality changes
337337

338338
By following these guidelines, you help Maia understand your widget's capabilities and provide better assistance to developers using your pluggable widget.
339339

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ The following widgets are supported if they have been installed:
9696
* [Progress Bar](/appstore/widgets/progress-bar/) (Studio Pro 11.1 and above)
9797
* [Progress Circle](/appstore/widgets/progress-circle/) (Studio Pro 11.1 and above)
9898

99+
{{% alert color="info" %}}
100+
In Studio Pro 11.6 and above, Maia can understand customized pluggable widgets when you enhance your widget definition XML file with the `<prompt>` element. For more information, see the [How to Enhance Your Pluggable Widget for Maia by Using `<prompt>`](/apidocs-mxsdk/apidocs/pluggable-widgets/#using-prompt-for-maia) section in *Pluggable Widgets API*.
101+
{{% /alert %}}
102+
99103
## Read More
100104

101105
* [Pages](/refguide/page/)

0 commit comments

Comments
 (0)