Merge pull request #11122 from mendix/qt-review

Review Extensibility APIs

Author: quinntracy

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/app-explorer-api.md

@@ -2,19 +2,20 @@
 title: "Using the App Explorer API"
 linktitle: "App Explorer API"
 url: /apidocs-mxsdk/apidocs/web-extensibility-api-11/app-explorer-api/
+description: "Describes how to interact with the App Explorer in Studio Pro by creating a context menu for microflows."
 ---
 
 ## Introduction
 
-This how-to describes how to interact with the App Explorer in Studio Pro. In this example, you create a menu which will show for each microflow in the App Explorer.
+This how-to describes how to interact with the App Explorer in Studio Pro. In this example, you create a menu that displays for each microflow in the App Explorer.
 
 ## Prerequisites
 
 {{% alert="info" %}}
-If you are using Studio Pro 11.0–11.5 and your extension includes menus, your existing menu code will not work when you upgrade to Studio Pro 11.6. To restore full functionality and support, upgrade to the Extensibility API 11.6 and follow the steps in the [Migration Guide](/apidocs-mxsdk/apidocs/web-extensibility-api-11/migration-guide/).
+If you are using Studio Pro 11.0–11.5 and your extension includes menus, your existing menu code will not work when you upgrade to Studio Pro 11.6. To restore full functionality and support, upgrade to Extensibility API 11.6 and follow the steps in the [Migration Guide](/apidocs-mxsdk/apidocs/web-extensibility-api-11/migration-guide/).
 {{% /alert%}}
 
-Before starting this how-to, make sure you have completed the following prerequisites:
+Before starting this how-to, complete the following prerequisites:
 
 * Review [how menus work](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu/) in the Web Extensibility API
 * This how-to uses the results of [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/). Complete that how-to before starting this one.
@@ -25,7 +26,7 @@ Before starting this how-to, make sure you have completed the following prerequi
 Use the full name of the document type to specify which type of document a menu should belong to (for example, `Microflows$Microflow` for microflows or `Pages$Page` for pages). For more information about these document type names, see [Access a Mendix Model Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/model-api/).
 {{% /alert %}}
 
-The code below uses the `appExplorer` API's `addContextMenu` method to add the menu to all `Microflow` document nodes. When this menu is clicked, the document's Id is sent as an argument through the `DocumentContext` argument parameter of the menu.
+The code below uses the `appExplorer` API `addContextMenu` method to add the menu to all `Microflow` document nodes. When you click this menu, the document ID is sent as an argument through the `DocumentContext` argument parameter of the menu.
 
 ```typescript
 import { ComponentContext, DocumentContext, IComponent, Menu, getStudioProApi } from "@mendix/extensions-api";
@@ -53,9 +54,9 @@ export const component: IComponent = {
 };
 ```
 
-The `DocumentContext` payload for the menu action is an object containing a document Id (`{ documentId: string }`). When creating a menu for the `appExplorer`'s `addContextMenu` method, the `DocumentContext` should be used as the context of your menu. The `documentId` will be the Id of the document the menu is attached to (in this example, the exact `Microflow` node in the App Explorer).
+The `DocumentContext` payload for the menu action is an object containing a document ID (`{ documentId: string }`). When you create a menu for the `appExplorer` `addContextMenu` method, use the `DocumentContext` as the context of your menu. The `documentId` is the ID of the document the menu is attached to (in this example, the exact `Microflow` node in the App Explorer).
 
-As explained in the [menu documentation](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu/), the `DocumentContext` is not necessary to add your menu to Studio Pro. However, if it is not used, the menu will not receive the clicked document's ID.
+As explained in the [menu documentation](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu/), the `DocumentContext` is not necessary to add your menu to Studio Pro. However, if you do not use it, the menu will not receive the clicked document ID.
 
 ## Extensibility Feedback
 

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/custom-blob-document-api.md

@@ -2,11 +2,12 @@
 title: "Register New Document Types With a Corresponding Editor"
 linktitle: "Introduce New Document Types"
 url: /apidocs-mxsdk/apidocs/web-extensibility-api-11/custom-blob-document-api/
+description: "Describes how to introduce a new document type and set up a custom editor that allows users to edit documents of that type."
 ---
 
 ## Introduction
 
-This how-to describes how to introduce a new document type and set up a custom editor that allows users to edit documents of that type.
+This how-to describes how to introduce a new document type and set up a custom editor for users to edit documents of that type.
 
 ## Prerequisites
 
@@ -16,13 +17,13 @@ Before starting this how-to, make sure you have completed the following prerequi
 
 ## Custom Document Model
 
-Studio Pro allows you to extend its metamodel by adding custom document types. These documents can store arbitrary data that can be serialized as strings. If you register an editor (a user-defined UI component) for a specific document type, documents of that type will be displayed in the UI alongside any other built-in document type, such as constants, Java Actions, and pages. Specifically, they will appear in the **New Document** and **Find Advanced** dialogs, context menus for adding documents, the App Explorer, and other UI elements that show Studio Pro documents. You can register custom editors to appear either as tabs or as modal dialogs.
+Studio Pro allows you to extend its metamodel by adding custom document types. These documents can store arbitrary data that can be serialized as strings. When you register an editor (a user-defined UI component) for a specific document type, documents of that type appear in the UI alongside built-in document types such as constants, Java actions, and pages. They appear in the **New Document** and **Find Advanced** dialogs, context menus for adding documents, the App Explorer, and other UI elements that display Studio Pro documents. You can register custom editors to appear as tabs or as modal dialogs.
 
 ## Registering a New Document Type
 
-To register a new document type, follow the steps below:
+To register a new document type, follow these steps:
 
-1. Generate a new extension named `myextension` as described in the [Get Started](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/) guide.
+1. Generate a new extension named `myextension` as described in [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/).
 2. Replace the contents of `src/main/index.ts` with the code below:
 
     ```typescript {hl_lines=["8-24"]}
@@ -244,30 +245,31 @@ To register a new document type, follow the steps below:
 
 ### Register the Document Type
 
-In `src/main/index.ts`, you begin by registering a new document type. Once registered, you can perform all CRUD operations on it. However, it will not appear in the UI until an editor is also registered. 
+In `src/main/index.ts`, you register a new document type. After you register the document type, you can perform all CRUD operations on it. However, the document type does not appear in the UI until you also register an editor. 
 
-Optionally, you can provide a `readableTypeName` to display a user-friendly name in logs and the Studio Pro UI instead of the full type name. You can also customize serialization of the document contents to a string. By default, the API uses `JSON.stringify` for serialization and `JSON.parse` for deserialization.
+Optionally, you can provide a `readableTypeName` to display a user-friendly name in logs and the Studio Pro UI instead of the full type name. You can also customize how the document contents serialize to a string. By default, the API uses `JSON.stringify` for serialization and `JSON.parse` for deserialization.
 
 ### Register the Editor
 
-The next call to the Studio Pro API in `src/main/index.ts` registers an editor for the document type. This does the following:
+The next call to the Studio Pro API in `src/main/index.ts` registers an editor for the document type. This call does the following:
 
-* It registers the `editor` entry point of the extension to the document type, so the editor is shown when users interacts with the document in Studio Pro (for example, through the **App Explorer** or **Find Results**).
-* This editor is shown as a tab, but you can also configure it to be shown as a modal dialog. 
-* Icons for both the light and dark themes are registered; these icons appear wherever a document icon is needed.
-* Note that this editor will behave like editors for other, built-in document types. For example, the `studioPro.ui.editors.editDocument` call will open the registered editor for custom documents.
+* Registers the `editor` entry point of the extension to the document type, so the editor appears when users interact with the document in Studio Pro (for example, through the **App Explorer** or **Find Results**)
+* Displays the editor as a tab, though you can also configure it to display as a modal dialog
+* Registers icons for both the light and dark themes; these icons appear wherever a document icon is needed
+
+This editor behaves like editors for other built-in document types. For example, the `studioPro.ui.editors.editDocument` call opens the registered editor for custom documents.
 
 ### Changes in the Editor
 
-In `src/ui/editor.tsx`, the first highlighted block of code listens for changes to documents to ensure the most recent version of the currently active document is shown. Note that the document can be changed outside the currently open editor, either by calls to the custom blob document API, or by Studio Pro operations like **Undo**.
+In `src/ui/editor.tsx`, the first highlighted block of code listens for changes to documents. This ensures the most recent version of the currently active document appears. The document can change outside the currently open editor, either through calls to the custom blob document API or through Studio Pro operations like **Undo**.
 
-In the next highlighted block, document contents are fetched whenever a new document is opened or an existing document is updated. 
+In the next highlighted block, document contents are fetched whenever a new document opens or an existing document updates. 
 
-We then provide a way to save changes.
+The code then provides a way to save changes.
 
 ### Update Build and Manifest Files
 
-Highlighted text in `build-extension.mjs` and `manifest.json` shows changes necessary to ensure the `editor` entry point is built and loaded properly.
+The highlighted text in `build-extension.mjs` and `manifest.json` shows the changes necessary to ensure the `editor` entry point builds and loads properly.
 
 ## Extensibility Feedback