Skip to content

Commit 2ba6975

Browse files
Merge remote-tracking branch 'upstream/development' into development
2 parents edfcda3 + 3baf6c8 commit 2ba6975

18 files changed

Lines changed: 372 additions & 44 deletions

File tree

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Check Claude Configuration
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- '.claude/**'
7+
- 'CLAUDE.md'
8+
9+
jobs:
10+
check-claude-config:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Check for Claude configuration changes
14+
uses: actions/github-script@v7
15+
with:
16+
script: |
17+
const comment = `⚠️ **Claude Configuration Warning**
18+
19+
You've modified Claude Code configuration files. These files contain the shared configuration for all contributors. Please revert this change if unintended. **ONLY modify these files if you need to change shared configurations that apply to everyone and have discussed this change with the TW team.**
20+
21+
To override the Claude settings locally, use \`.claude/settings.local.json\` instead.
22+
23+
**For example, if you're changing AWS_PROFILE:**
24+
The default profile name is \`my-sandbox\`. If your AWS profile has a different name, override it locally instead of changing the shared file.
25+
26+
Create or edit \`.claude/settings.local.json\` in the repo root and include the following lines:
27+
28+
\`\`\`json
29+
{
30+
"env": {
31+
"AWS_PROFILE": "your-sandbox-name"
32+
}
33+
}
34+
\`\`\`
35+
36+
This local file is gitignored and overrides the repo default.`;
37+
38+
github.rest.issues.createComment({
39+
issue_number: context.issue.number,
40+
owner: context.repo.owner,
41+
repo: context.repo.repo,
42+
body: comment
43+
});
44+
45+
core.setFailed('Claude configuration was modified - see comment for guidance');

CLAUDE.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,3 +200,7 @@ If you are unsure whether a command is safe to run, **do not run it**. Instead,
200200
- Run tests after making changes: see project-specific test commands
201201
- Do not add dependencies without asking
202202
- Do not refactor code beyond what was requested
203+
204+
### Claude Code Settings Management
205+
206+
For personal configuration changes (AWS_PROFILE, etc.), always suggest `.claude/settings.local.json` instead of modifying `.claude/settings.json`. The local file is gitignored and overrides shared settings.

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
For guidelines on contributing to the Mendix documentation, please see these two documents:
1+
For guidelines on contributing to the Mendix documentation, see these documents:
22

33
* [How to Contribute to Mendix Docs](https://docs.mendix.com/community-tools/contribute-to-mendix-docs/)
44
* [Documentation Writing Guidelines](https://docs.mendix.com/community-tools/documentation-guidelines/)
5+
* [Using AI Tools for Documentation](https://docs.mendix.com/community-tools/contribute-to-mendix-docs/using-ai-tools/)
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: "Using AI Tools for Documentation"
3+
url: /community-tools/contribute-to-mendix-docs/using-ai-tools/
4+
weight: 30
5+
description: "Guidelines for using AI tools when contributing to Mendix documentation."
6+
---
7+
8+
## Introduction
9+
10+
Contributors may use AI tools such as large language models and writing assistants to draft or improve documentation. However, these tools must be treated as writing aids, like spell-checkers or linters, and not as authoritative sources.
11+
12+
## Contributor Responsibility
13+
14+
If you use AI tools, before contributing, you must:
15+
16+
* Review and verify the accuracy of all AI-assisted content.
17+
* Ensure the content does not infringe on third-party copyrights.
18+
* Remove hallucinated content or unsupported claims.
19+
* Confirm that the AI tool's terms do not impose restrictions inconsistent with Mendix's contributors license agreement.
20+
21+
AI output must be treated as unverified draft material.
22+
23+
## Maintainer Discretion
24+
25+
Maintainers may request clarification, edits, or removal of AI-assisted content if concerns arise regarding accuracy, licensing, or quality.
26+
27+
## Using AI Assistants
28+
29+
This repository is configured for use with [Claude Code](https://code.claude.com/docs/en/vs-code), an AI-powered coding assistant. There is also GitHub Copilot customization for contributors who use it.
30+
31+
### Claude Code Configuration
32+
33+
The default AWS profile name is `my-sandbox`. If your AWS sandbox profile has a different name, create `.claude/settings.local.json` in the repo root and include the following lines:
34+
35+
```json
36+
{
37+
"env": {
38+
"AWS_PROFILE": "your-sandbox-name"
39+
}
40+
}
41+
```
42+
43+
This file is gitignored and will override the shared settings.
44+
45+
{{% alert color="warning" %}}
46+
Do not modify `.claude/settings.json` or other files in the `.claude/` directory for personal configuration. These files contain shared configuration for all contributors.
47+
{{% /alert %}}
48+
49+
### Custom Skills
50+
51+
This repository includes custom Claude Code skills optimized for documentation work:
52+
53+
* `/proofread` - Checks spelling, grammar, punctuation, and basic Markdown formatting
54+
* `/polish` - Improves clarity, readability, and word choice without changing meaning
55+
* `/enhance` - Performs comprehensive editing including reorganization, restructuring, and stronger phrasing
56+
* `/review` - Analyzes documentation and generates suggestions for improvements
57+
* `/add` - Adds new content to an existing page while preserving original structure
58+
59+
These skills are available to all contributors using Claude Code with this repository.
60+
61+
## Read More
62+
63+
* [Contributing to Mendix Docs](/community-tools/contribute-to-mendix-docs/)
64+
* [Documentation Writing Guidelines](/community-tools/documentation-guidelines/)

content/en/docs/control-center/security/software-composition/components.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ The component list contains the following information:
4848
* **Support type** — The support type of the Marketplace component. This can be **Mendix**, **Partner**, or **Community**.
4949
For more information, refer to [Content Support Categories](/appstore/marketplace-content-support/#category).
5050
* **Version** — The version of the component that is being used.
51-
* **Findings**This shows the number of findings of each type, color-coded according to severity level.
51+
* **Findings**The number of findings of each type, color-coded according to severity level.
5252
* **License** — For components derived from the Mendix Marketplace, this is the end-user license for the component.
5353
* **Marketplace** – Whether the component is **Public** or **Private**. A public component is available to the whole Mendix community in the Marketplace, while a private component is available only via your [Company Content](/appstore/home-page/#company-content) page.
5454
* **Apps using component** – The number of apps where the component is used.
55-
* **Latest version**The latest version of the component.
56-
* **Publisher** — The name of the organization that published the component.
55+
* **Latest version**For components derived from the Mendix Marketplace, this is the latest version of the component.
56+
* **Publisher** — For components derived from the Mendix Marketplace, this is the name of the organization that published the component.
5757
* **View details** — Clicking this opens the [Component Details](#component-details) page.
5858
* Column customization ({{% icon name="view" %}}) – You can customize the columns of the list by clicking the {{% icon name="view" %}} icon and selecting or deselecting options.
5959

content/en/docs/control-center/security/software-composition/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,10 +133,10 @@ The component usage list contains the following information:
133133
* **Support type** – The support type of the Marketplace component. This can be **Mendix**, **Partner**, or **Community**.
134134
For more information, refer to [Content Support Categories](/appstore/marketplace-content-support/#category).
135135
* **License** – For components derived from the Mendix Marketplace, this is the end-user license for the component.
136-
* **Latest version**The latest version of the component.
136+
* **Latest version**For components derived from the Mendix Marketplace, this is the latest version of the component.
137137
* **Marketplace** – Whether the component is **Public** or **Private**. A public component is available to the whole Mendix community in the Marketplace, while a private component is available only via your [Company Content](/appstore/home-page/#company-content) page.
138138
* **Latest Runtime Compatible Version** — The most recent runtime version to which the component is compatible.
139-
* **Publisher** – The name of the organization that published the component.
139+
* **Publisher** – For components derived from the Mendix Marketplace, this is the name of the organization that published the component.
140140
* Column customization ({{% icon name="view" %}}) – You can customize the columns of the list by clicking the {{% icon name="view" %}} icon and selecting or deselecting options.
141141

142142
To export the information corresponding to selected items in the list to an Excel file, select the checkboxes of the items in the list, then click **Selection Export** that appears at the bottom of the page.

content/en/docs/deployment/general/software-composition.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,11 @@ The component list contains the following information:
153153
* **Support type** — The support type of the Marketplace component. This can be **Mendix**, **Partner**, or **Community**.
154154
For more information, refer to [Content Support Categories](/appstore/marketplace-content-support/#category).
155155
* **Version** — The version of the component that is being used.
156-
* **Findings**This shows the number of findings of each type, color-coded according to severity level.
156+
* **Findings**The number of findings of each type, color-coded according to severity level.
157157
* **License** — For components derived from the Mendix Marketplace, this is the end-user license for the component.
158158
* **Marketplace** – Whether the component is **Public** or **Private**. A public component is available to the whole Mendix community in the Marketplace, while a private component is available only via your [Company Content](/appstore/home-page/#company-content) page.
159-
* **Latest version**The latest version of the component.
160-
* **Publisher** — The name of the organization that published the component.
159+
* **Latest version**For components derived from the Mendix Marketplace, this is the latest version of the component.
160+
* **Publisher** — For components derived from the Mendix Marketplace, this is the name of the organization that published the component.
161161
* **View details** — Clicking this opens the [Component App Details](#component-usage) page.
162162
* Column customization ({{% icon name="view" %}}) – You can customize the columns of the list by clicking the {{% icon name="view" %}} icon and selecting or deselecting options.
163163

content/en/docs/developerportal/_index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@ The following sections describe the process for each option.
2929

3030
### Creating an App with Maia
3131

32-
{{% alert color="warning" %}}
33-
This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
34-
{{% /alert %}}
35-
3632
Follow the steps in [Maia Plan](/developerportal/maia-plan/) to enlist Maia's help in planning and creating an app.
3733

3834
### Creating an App from a Starter App Template

content/en/docs/developerportal/maia-plan.md

Lines changed: 49 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,36 +3,35 @@ title: "Maia Plan"
33
url: /developerportal/maia-plan/
44
description: "Describes the process of planning and building an app using Maia."
55
weight: 3
6-
beta: true
76
---
87

9-
{{% alert color="warning" %}}
10-
This feature is in Public Beta. For more information, refer to [Release Status](/releasenotes/release-status/).
11-
{{% /alert %}}
12-
138
## Introduction
149

15-
You can use Maia Plan to plan and generate an app. This page details the steps involved in providing project context, reviewing and refining the generated project scope, and approving the solution proposal to initiate app development.
10+
You can use Maia Plan to plan and generate an app. This page describes how to provide project context, review and refine the generated project scope, and approve the solution proposal to initiate app development.
1611

17-
{{< figure src="/attachments/developerportal/maia/maia-create-app-beta.png" alt="Plan and build with Maia" >}}
12+
{{< figure src="/attachments/developerportal/maia/maia-create-app.png" alt="Plan and build with Maia" max-width=50% >}}
1813

1914
## Creating an App with Maia Plan
2015

21-
Follow these steps to have Maia Plan create an app for you:
16+
Go through the steps in the following sections to have Maia Plan create an app for you.
17+
18+
### Adding Project Details
2219

2320
1. In **Apps**, click **Create App** in the upper right corner.
2421

2522
2. Select **Plan & Build with Maia**.
2623

27-
3. In the **Project Context** text box, enter as much detail as possible about your future app. These are some details that you could add to help Maia generate an app for you:
24+
3. In the **Project Context** text box, enter as much detail as possible about your future app. Include the following information to help Maia generate an accurate app plan:
2825

2926
* Describe your goals.
3027
* Describe your targeted users.
3128
* List out success criteria.
3229
* Add requirements.
3330
* Attach documents, sketches, images.
3431

35-
4. Click **Generate Plan**. The **Project Scope** window is displayed, and Maia starts populating it with the proposed project scope.
32+
### Generating the Project Scope
33+
34+
1. Once you have added all the preliminary details, click **Generate Plan**. The **Project Scope** window is displayed, and Maia starts populating it with the proposed project scope.
3635
The app plan becomes available on the **Apps** page as soon as you click **Generate Plan** at the beginning of the workflow. As such, you can go back to the plan at any time after you leave it, and you can already add team members to the app.
3736

3837
Once the **Project Scope** window is populated, you can see the following information generated by Maia:
@@ -61,22 +60,49 @@ Follow these steps to have Maia Plan create an app for you:
6160

6261
You can use the pane on the right to chat with Maia about your requirements for the new app.
6362

64-
5. Once you review the project scope and make any changes you deem necessary, click **Approve Project Scope** in the top right of the page. The status of the project scope changes from **Draft** to **Approved**.
63+
2. Once you review the project scope and make any changes you deem necessary, click **Approve Project Scope** in the top right of the page. The status of the project scope changes from **Draft** to **Approved**.
64+
65+
### Generating the Solution Proposal
6566

66-
6. Click **Generate Solution** in the top right of the page. The **Solution Proposal** window is displayed, and Maia starts populating it with the proposed project scope.
67-
While the solution proposal is being generated, as well as after it's displayed, the **Project Scope** is locked. If you want to make changes to it, you can click the lock icon to unlock it.
68-
Once the **Solution Proposal** window is populated, you can see the following information generated by Maia:
67+
If you agree with the project scope, click **Generate Solution** in the top right of the page. The **Solution Proposal** window is displayed, and Maia starts populating it with the proposed project scope.
68+
While the solution proposal is being generated, as well as after it's displayed, the **Project Scope** is locked. If you want to make changes to it, you can click the lock icon to unlock it.
69+
Once the **Solution Proposal** window is populated, you can see the following information generated by Maia:
6970

70-
* Cards corresponding to each epic which contributes to building the app.
71-
You can remove epics by hovering over them, then clicking the trash can icon.
72-
Click the card itself to:
71+
* Cards corresponding to each epic which contributes to building the app.
72+
You can remove epics by hovering over them, then clicking the trash can icon.
73+
Click the card itself to:
7374

74-
* See the entire list of stories for an epic in the right side panel.
75-
* Edit the description or details of the epic.
75+
* See the entire list of stories for an epic in the right side panel.
76+
* Edit the description or details of the epic.
7677

77-
You can perform the following actions on each story:
78+
You can perform the following actions on each story:
79+
80+
* To see the full details of a story or to edit it, click the three-dot menu, then select **Edit**.
81+
* To remove a story, click the three-dot menu, then select **Delete**.
82+
83+
<!--
84+
#### Recommended Marketplace Components {#recommender}
85+
86+
{{% alert color="warning" %}} This feature is in Public Beta. For more information, refer to Release Status. {{% /alert %}}
87+
88+
If Mendix identifies Marketplace components that can be used to implement a specific story, they are displayed in the following places:
89+
90+
* At the epic level, as a number. Example: *1 Resource*.
91+
* At the user story level, in the side panel. From here, you can perform the following actions:
92+
93+
* If you want more details about the component, click it to access its page in the Marketplace.
94+
* If you do not want a component to be used, delete it by clicking the trash can icon.
95+
96+
If your company has company-approved components, Maia only returns company-approved components from the Public and the Private Marketplace.
97+
If your company does not have company-approved components, Maia returns the following types of components:
98+
99+
* platform-supported components
100+
* all Private Marketplace components
101+
-->
102+
103+
### Opening the App
78104

79-
* To see the full details of a story or to edit it, click the three-dot menu, then select **Edit**.
80-
* To remove a story, click the three-dot menu, then select **Delete**.
105+
Once you are happy with Maia's suggested project plan, click **Open in Studio Pro** in the top right of the page. This opens Studio Pro, where you can continue working on the new app. <!-- Note that, at the moment, Studio Pro does not take into account [recommended components](#recommender). -->
106+
For details, refer to [Maia Make](/refguide/maia-make/) in the Studio Pro documentation.
81107

82-
7. Once you are happy with Maia's suggested project plan, click **Open in Studio Pro** in the top right of the page. This opens Studio Pro, where you can continue working on the new app. For details, refer to [Maia Make](/refguide/maia-make/) in the Studio Pro documentation.
108+
You can also click **Open in Planning** to open the **Planning** window of the new app, which includes all the project's stories. <!-- Note that, if you click **Open in Planning** before Maia is done [finding recommendations](#recommender), recommended components are not displayed in the **Planning** window. -->

0 commit comments

Comments
 (0)