MS-3808 review sdk docs #9312
Merged
MS-3808 review sdk docs #9312
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is no longer needed in v5.
ahmed-negm
reviewed
Apr 7, 2025
content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/creating-your-first-script.md
Outdated
Show resolved
Hide resolved
content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/using-platform-sdk.md
Outdated
Show resolved
Hide resolved
content/en/docs/apidocs-mxsdk/mxsdk/sdk-howtos/using-platform-sdk.md
Outdated
Show resolved
Hide resolved
...apidocs-mxsdk/mxsdk/sdk-howtos/manipulating-existing-models/closing-the-server-connection.md
Outdated
Show resolved
Hide resolved
...apidocs-mxsdk/mxsdk/sdk-howtos/manipulating-existing-models/closing-the-server-connection.md
Outdated
Show resolved
Hide resolved
...s/apidocs-mxsdk/mxsdk/sdk-howtos/manipulating-existing-models/finding-things-in-the-model.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Looks good.
I have asked a couple of questions which you can see below.
Two questions:
- Do the changes you have made apply to all versions of the SDK (above 5.0) or are there specific versions where the previous code had to be used?
- There is a message at the top of https://docs.mendix.com/apidocs-mxsdk/mxsdk/ which says the versions below 5.0 will be removed in 2024. I think this needs to be updated too?
| @@ -1,6 +1,6 @@ | |||
| --- | |||
| title: "Close the Server Connection" | |||
| url: /apidocs-mxsdk/mxsdk/closing-the-server-connection/ | |||
| url: /apidocs-mxsdk/mxsdk/old-closing-the-server-connection/ | |||
There was a problem hiding this comment.
I think that there should be an indication at the top of this file as to why this URL has changed to "old" and where customers should go for the "new" close the server connection API.
There was a problem hiding this comment.
Let's entirely remove this document. This is no longer relevant and it may create confusion, all examples uses model.flushChanges() and this is the way to go.
| @@ -45,16 +49,14 @@ You can pass the following options to `createNewApp`: | |||
|
|
|||
| If both `templateDownloadURL` and `templateId` are left blank, the app will be created using the standard blank app template in the latest Mendix version. | |||
|
|
|||
| Here is an example for creating a Mendix app based on the [Asset Manager App](https://marketplace.mendix.com/link/component/69674) template: | |||
| Here is an example for creating a Mendix app based on the [Blank GenAI App](https://marketplace.mendix.com/link/component/227934) template: | |||
There was a problem hiding this comment.
There is a new version of this template, so perhaps add the version we are using?
Suggested change
| Here is an example for creating a Mendix app based on the [Blank GenAI App](https://marketplace.mendix.com/link/component/227934) template: | |
| Here is an example for creating a Mendix app based on version 2.1.0 of the [Blank GenAI App](https://marketplace.mendix.com/link/component/227934) template: |
This is no longer relevant, users shouls use model.flushChages() instead
|
MarkvanMents
approved these changes
Apr 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Spring cleaning for our model-sdk and platform-sdk docs