Skip to content

Commit 7524600

Browse files
committed
DOC-3356: Rename TinyMCE AI Review and Actions pages for URL clarity
Rename tinymceai-review-plugin and tinymceai-actions-plugin to tinymceai-review and tinymceai-actions so paths reflect features under the tinymceai plugin. Update navigation, cross-references, and partials.
1 parent 19a6014 commit 7524600

13 files changed

Lines changed: 42 additions & 42 deletions

modules/ROOT/nav.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,8 @@
257257
*** TinyMCE AI
258258
**** xref:tinymceai-introduction.adoc[Introduction]
259259
**** xref:tinymceai-chat.adoc[Chat]
260-
**** xref:tinymceai-review-plugin.adoc[Review]
261-
**** xref:tinymceai-actions-plugin.adoc[Actions]
260+
**** xref:tinymceai-review.adoc[Review]
261+
**** xref:tinymceai-actions.adoc[Actions]
262262
**** xref:tinymceai-models.adoc[AI Models]
263263
**** xref:tinymceai-limits.adoc[Limits]
264264
**** xref:tinymceai-integration-options.adoc[Integration Options]

modules/ROOT/pages/tinymceai-actions-plugin.adoc renamed to modules/ROOT/pages/tinymceai-actions.adoc

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Preview transformations and Actions API calls are **stateless**: each invocation
1515
The Quick Actions feature is available as part of the `+tinymceai+` plugin for {productname} and through the Actions API. This page covers both:
1616

1717
* Plugin sections describe user-facing features and configuration (xref:tinymceai.adoc#options-quickactions[Quick Actions configuration]).
18-
* API sections cover REST API access (starting at xref:tinymceai-actions-plugin.adoc#actions-api[Actions API]).
18+
* API sections cover REST API access (starting at xref:tinymceai-actions.adoc#actions-api[Actions API]).
1919
2020
[[demo]]
2121
== Demo
@@ -32,7 +32,7 @@ Quick Actions fit transforming a selection or section (for example grammar fixes
3232
Both Quick Actions and Review can propose edits that apply only after acceptance or rejection. The main differences are scope and where the work happens in the editor:
3333

3434
* *Quick Actions*: Operate on a selection or section (including the full document when the scope includes it). The Quick Actions menu runs one-off operations such as Chat with a pre-filled prompt, preview transformations, translation, and custom actions.
35-
* *Review*: Always analyzes the entire document in read-only Review mode. Suggestions appear in the Review sidebar and in the document. See xref:tinymceai-review-plugin.adoc[Review] for details.
35+
* *Review*: Always analyzes the entire document in read-only Review mode. Suggestions appear in the Review sidebar and in the document. See xref:tinymceai-review.adoc[Review] for details.
3636

3737
[[integration]]
3838
== Integration
@@ -48,7 +48,7 @@ image::tinymceai/tinymce-ai-quick-actions-change-tone-flyout-submenu.png[{plugin
4848

4949
Finally, individual Quick Actions can also be added to the toolbar as shortcuts for easier access.
5050

51-
For example, add the `ai-quickactions-improve-writing` image:icons-premium/improve-writing.svg[Improve Writing icon,24px] button, or the `ai-chat-explain` image:icons-premium/explain.svg[Explain icon,24px] button (find it in the demo above). Whole categories can be added to the toolbar as well. Learn more about xref:tinymceai-actions-plugin.adoc#default-actions[available actions].
51+
For example, add the `ai-quickactions-improve-writing` image:icons-premium/improve-writing.svg[Improve Writing icon,24px] button, or the `ai-chat-explain` image:icons-premium/explain.svg[Explain icon,24px] button (find it in the demo above). Whole categories can be added to the toolbar as well. Learn more about xref:tinymceai-actions.adoc#default-actions[available actions].
5252

5353
The final example configuration looks as follows:
5454

@@ -106,21 +106,21 @@ There are two types of actions available in the quick actions feature:
106106

107107
* Preview actions such as _Continue writing_, _Make shorter_, _Improve writing_, and _Fix grammar_ show a preview of your document where suggested edits appear so you can review them and apply or skip each change.
108108

109-
Custom actions let integrators define whether each action opens Chat or shows a preview. See xref:tinymceai-actions-plugin.adoc#custom-actions[Custom Actions].
109+
Custom actions let integrators define whether each action opens Chat or shows a preview. See xref:tinymceai-actions.adoc#custom-actions[Custom Actions].
110110

111111
[[default-actions]]
112112
== Default Actions
113113

114114
By default, the Quick Actions feature includes several built-in actions that speed up the content editing process. All Quick Actions can be accessed through the menu button image:icons/ai-prompt.svg[Quick Actions icon,24px] (`tinymceai-quickactions`) or individually when selected by the integrator in the xref:toolbar-configuration-options.adoc[editor toolbar configuration]. Whole action categories can be added to the toolbar as well.
115115

116-
Custom actions can be added to the list, and default actions can be removed or reordered by configuring `tinymceai_quickactions_menu`. See xref:tinymceai-actions-plugin.adoc#configuring-quick-actions-menu[Configuring Quick Actions menu].
116+
Custom actions can be added to the list, and default actions can be removed or reordered by configuring `tinymceai_quickactions_menu`. See xref:tinymceai-actions.adoc#configuring-quick-actions-menu[Configuring Quick Actions menu].
117117

118118
[[quick-actions-reference-table]]
119119
The following table lists built-in Quick Actions.
120120

121121
* The **Editor** column is the label in the Quick Actions menu when that action is available in the editor.
122-
* The **Menu or control ID** column lists values for `tinymceai_quickactions_menu`, `tinymceai_quickactions_chat_prompts`, `tinymceai_quickactions_change_tone_menu`, and the toolbar when adding individual controls (see xref:tinymceai-actions-plugin.adoc#configuring-quick-actions-menu[Configuring Quick Actions menu]).
123-
* The **System `actionName` or quick-action prompt id** column is the service identifier. Preview actions use a system `actionName` with the xref:tinymceai-actions-plugin.adoc#actions-api[Actions API]. Chat actions use a quick-action prompt id and xref:tinymceai-chat.adoc[Chat] with a pre-filled prompt, not the system actions API.
122+
* The **Menu or control ID** column lists values for `tinymceai_quickactions_menu`, `tinymceai_quickactions_chat_prompts`, `tinymceai_quickactions_change_tone_menu`, and the toolbar when adding individual controls (see xref:tinymceai-actions.adoc#configuring-quick-actions-menu[Configuring Quick Actions menu]).
123+
* The **System `actionName` or quick-action prompt id** column is the service identifier. Preview actions use a system `actionName` with the xref:tinymceai-actions.adoc#actions-api[Actions API]. Chat actions use a quick-action prompt id and xref:tinymceai-chat.adoc[Chat] with a pre-filled prompt, not the system actions API.
124124

125125
[cols="1,3,2,3,1,1",options="header"]
126126
|===
@@ -185,7 +185,7 @@ For system action endpoints, schemas, and streaming details, see the https://tin
185185
[[custom-actions]]
186186
== Custom Actions
187187

188-
The `tinymceai_quickactions_custom` configuration property allows adding new commands to the Quick actions feature. The items can be of type `action` (a quick action that shows a preview of the editor content with AI suggestions so changes can be reviewed before applying) or type `chat` (which opens the chat interface for a conversation related to the prompt and selection). The `title` is used in the menu items, while the `prompt` is what is actually sent to the AI. The `model` is required for `action` type commands. Learn more about xref:tinymceai-actions-plugin.adoc#types-of-actions[types of actions].
188+
The `tinymceai_quickactions_custom` configuration property allows adding new commands to the Quick actions feature. The items can be of type `action` (a quick action that shows a preview of the editor content with AI suggestions so changes can be reviewed before applying) or type `chat` (which opens the chat interface for a conversation related to the prompt and selection). The `title` is used in the menu items, while the `prompt` is what is actually sent to the AI. The `model` is required for `action` type commands. Learn more about xref:tinymceai-actions.adoc#types-of-actions[types of actions].
189189

190190
[source,js]
191191
----
@@ -263,14 +263,14 @@ tinymce.init({
263263
[[actions-api]]
264264
== Actions API
265265

266-
The Quick Actions plugin feature is built on top of the Actions API, which provides REST API access to action functionality. Actions are fast, stateless operations—each request is independent, as described under xref:tinymceai-actions-plugin.adoc#stateless-actions[Stateless actions]. For suggestions that change the document, the preview flow applies edits only after each suggestion is accepted or rejected. Actions that only open Chat with a pre-filled prompt use the Conversations API; see xref:tinymceai-chat.adoc[Chat].
266+
The Quick Actions plugin feature is built on top of the Actions API, which provides REST API access to action functionality. Actions are fast, stateless operations—each request is independent, as described under xref:tinymceai-actions.adoc#stateless-actions[Stateless actions]. For suggestions that change the document, the preview flow applies edits only after each suggestion is accepted or rejected. Actions that only open Chat with a pre-filled prompt use the Conversations API; see xref:tinymceai-chat.adoc[Chat].
267267

268268
Actions use streaming output with Server-Sent Events for real-time feedback as results are generated.
269269

270270
[[actions-system-actions-api]]
271271
=== System Actions
272272

273-
Built-in Quick Actions—including identifiers, descriptions, and whether each command uses the system Actions API or Chat (Conversations API)—are summarized in xref:tinymceai-actions-plugin.adoc#quick-actions-reference-table[Default Actions].
273+
Built-in Quick Actions—including identifiers, descriptions, and whether each command uses the system Actions API or Chat (Conversations API)—are summarized in xref:tinymceai-actions.adoc#quick-actions-reference-table[Default Actions].
274274

275275
For endpoint details, request and response schemas, authentication, and streaming behavior for system `actionName` calls, see https://tinymceai.api.tiny.cloud/docs#tag/Actions[Actions API].
276276

@@ -297,4 +297,4 @@ The https://tinymceai.api.tiny.cloud/docs#tag/Actions[Actions API] reference (in
297297
== Related Features
298298

299299
* xref:tinymceai-chat.adoc[AI Chat]: For interactive discussions with document analysis and context.
300-
* xref:tinymceai-review-plugin.adoc[AI Review]: For content quality analysis and improvement suggestions.
300+
* xref:tinymceai-review.adoc[AI Review]: For content quality analysis and improvement suggestions.

modules/ROOT/pages/tinymceai-api-overview.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ New to TinyMCE AI? Start with the xref:tinymceai-api-quick-start.adoc[Quick Star
2121
== TinyMCE AI features
2222

2323
* xref:tinymceai-chat.adoc[**Chat**]: Interactive AI chats with history and persistent context.
24-
* xref:tinymceai-review-plugin.adoc[**Review**]: Content analysis and proofreading, optimized for larger content.
25-
* xref:tinymceai-actions-plugin.adoc[**Quick Actions**]: Fast, stateless operations for specific tasks.
24+
* xref:tinymceai-review.adoc[**Review**]: Content analysis and proofreading, optimized for larger content.
25+
* xref:tinymceai-actions.adoc[**Quick Actions**]: Fast, stateless operations for specific tasks.
2626

2727
[[architecture]]
2828
== Architecture

modules/ROOT/pages/tinymceai-api-quick-start.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ For an overview of all API features, see xref:tinymceai-api-overview.adoc[API Ov
7474
For feature documentation and API access information, see:
7575

7676
* xref:tinymceai-chat.adoc#conversations-api[Chat]: Interactive AI discussions and document analysis through the Conversations API.
77-
* xref:tinymceai-review-plugin.adoc#reviews-api[Review]: Content improvement and quality analysis through the Reviews API.
78-
* xref:tinymceai-actions-plugin.adoc#actions-api[Quick Actions]: Content transformation through the Actions API.
77+
* xref:tinymceai-review.adoc#reviews-api[Review]: Content improvement and quality analysis through the Reviews API.
78+
* xref:tinymceai-actions.adoc#actions-api[Quick Actions]: Content transformation through the Actions API.
7979
* xref:tinymceai-streaming.adoc[Streaming]: Real-time AI interactions with code examples.
8080

8181
link:https://tinymceai.api.tiny.cloud/docs[Complete API Documentation]: Full API reference with interactive examples for all endpoints.
@@ -90,6 +90,6 @@ After setting up the JWT endpoint, continue with:
9090
* xref:tinymceai-permissions.adoc[Permissions]: Set up user access control for production.
9191
* xref:tinymceai-streaming.adoc[Streaming]: Learn how to handle real-time streaming responses.
9292
* xref:tinymceai-chat.adoc#conversations-api[Chat API]: Start with interactive AI discussions.
93-
* xref:tinymceai-review-plugin.adoc#reviews-api[Review API]: Add content improvement features.
94-
* xref:tinymceai-actions-plugin.adoc#actions-api[Quick Actions API]: Implement content transformation.
93+
* xref:tinymceai-review.adoc#reviews-api[Review API]: Add content improvement features.
94+
* xref:tinymceai-actions.adoc#actions-api[Quick Actions API]: Implement content transformation.
9595
* xref:tinymceai-api-overview.adoc[API Overview]: Optional high-level map of Chat, Review, Quick Actions, and related resources.

modules/ROOT/pages/tinymceai-chat.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,5 +242,5 @@ The https://tinymceai.api.tiny.cloud/docs[interactive API documentation] lists e
242242
[[related-features]]
243243
== Related Features
244244

245-
* xref:tinymceai-review-plugin.adoc[AI Review]: For content quality analysis and improvement suggestions.
246-
* xref:tinymceai-actions-plugin.adoc[Quick actions]: For fast, stateless content transformations.
245+
* xref:tinymceai-review.adoc[AI Review]: For content quality analysis and improvement suggestions.
246+
* xref:tinymceai-actions.adoc[Quick actions]: For fast, stateless content transformations.

modules/ROOT/pages/tinymceai-introduction.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ include::partial$misc/tinymceai-on-premises-early-access-note.adoc[]
3434
There are three main features of {pluginname}.
3535

3636
* xref:tinymceai-chat.adoc[**Chat**]: Interactive AI chats with history and persistent context.
37-
* xref:tinymceai-review-plugin.adoc[**Review**]: Content analysis and proofreading, optimized for larger content.
38-
* xref:tinymceai-actions-plugin.adoc[**Actions**]: Fast, stateless operations for specific tasks.
37+
* xref:tinymceai-review.adoc[**Review**]: Content analysis and proofreading, optimized for larger content.
38+
* xref:tinymceai-actions.adoc[**Actions**]: Fast, stateless operations for specific tasks.
3939

4040
[NOTE]
4141
Existing customers on paid plans can request a full featured free trial through the link:{accountpageurl}[Customer Portal].

modules/ROOT/pages/tinymceai-jwt-authentication-intro.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -324,6 +324,6 @@ If an error indicates insufficient permissions:
324324
* xref:tinymceai-permissions.adoc[Permissions]: Complete permissions reference and examples.
325325
* xref:tinymceai-models.adoc[AI Models]: Model selection and capabilities.
326326
* xref:tinymceai-chat.adoc[Chat]: Interactive AI discussions.
327-
* xref:tinymceai-review-plugin.adoc[Review]: Content improvement.
328-
* xref:tinymceai-actions-plugin.adoc[Quick Actions]: Content transformation.
327+
* xref:tinymceai-review.adoc[Review]: Content improvement.
328+
* xref:tinymceai-actions.adoc[Quick Actions]: Content transformation.
329329
* link:https://tinymceai.api.tiny.cloud/docs[API Documentation]: Complete API reference for {pluginname}.

modules/ROOT/pages/tinymceai-models.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:description_short: AI model configuration
88
:keywords: AI, models, configuration, tinymceai
99

10-
{pluginname} supports multiple AI models from different providers. Which models may be used is determined by xref:tinymceai-permissions.adoc#model-permissions[model permissions] in the JWT; the plugin configuration UI, REST API request bodies, and per-action options (for example xref:tinymceai-actions-plugin.adoc[Quick Actions] custom items) then select which allowed model applies in each situation. This page covers model capabilities, configuration options, and limitations that apply to both plugin and API usage.
10+
{pluginname} supports multiple AI models from different providers. Which models may be used is determined by xref:tinymceai-permissions.adoc#model-permissions[model permissions] in the JWT; the plugin configuration UI, REST API request bodies, and per-action options (for example xref:tinymceai-actions.adoc[Quick Actions] custom items) then select which allowed model applies in each situation. This page covers model capabilities, configuration options, and limitations that apply to both plugin and API usage.
1111

1212
[[recommended-agent-models]]
1313
== Recommended: Agent Models
@@ -138,7 +138,7 @@ Plugin configuration, API parameters, and per-feature options do not grant acces
138138
* **JWT model permissions**: Set `ai:models:*`, `ai:models:agent`, `ai:models:<provider>:*`, or `ai:models:<provider>:<model-name>` as required. See xref:tinymceai-permissions.adoc#model-permissions[Model permissions] and xref:tinymceai-jwt-authentication-intro.adoc[JWT Authentication].
139139
* **Plugin configuration**: `tinymceai_default_model` sets the default model, and `tinymceai_allow_model_selection` controls whether end users can choose among allowed models in the UI. See xref:tinymceai.adoc#options-chat[Chat configuration options].
140140
* **API requests**: The `model` field in request bodies selects the model for that call. See xref:tinymceai-models.adoc#api-examples[API Examples] below.
141-
* **Custom Quick Actions and similar**: Per-item options such as the `model` property on xref:tinymceai-actions-plugin.adoc#custom-actions[custom Quick Actions] select a model for that action; the value must be among the models allowed by the JWT.
141+
* **Custom Quick Actions and similar**: Per-item options such as the `model` property on xref:tinymceai-actions.adoc#custom-actions[custom Quick Actions] select a model for that action; the value must be among the models allowed by the JWT.
142142

143143
[NOTE]
144144
====
@@ -394,6 +394,6 @@ The https://tinymceai.api.tiny.cloud/docs#tag/Models[Models API] section of the
394394
== Related Features
395395

396396
* xref:tinymceai-chat.adoc[Chat]: Use models in interactive AI discussions and configure model selection.
397-
* xref:tinymceai-review-plugin.adoc[Review]: Apply models to content analysis and improvement.
398-
* xref:tinymceai-actions-plugin.adoc[Quick Actions]: Use models for content transformation tasks.
397+
* xref:tinymceai-review.adoc[Review]: Apply models to content analysis and improvement.
398+
* xref:tinymceai-actions.adoc[Quick Actions]: Use models for content transformation tasks.
399399
* xref:tinymceai.adoc[Plugin Reference]: Complete plugin configuration options including model settings.

modules/ROOT/pages/tinymceai-permissions.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -261,5 +261,5 @@ When a user lacks required permissions, the API returns a `403 Forbidden` error
261261
* xref:tinymceai-jwt-authentication-intro.adoc[JWT Authentication]: JWT authentication setup and required claims.
262262
* xref:tinymceai-models.adoc[AI Models]: Model selection and capabilities.
263263
* xref:tinymceai-chat.adoc[Chat]: Interactive AI discussions.
264-
* xref:tinymceai-review-plugin.adoc[Review]: Content improvement.
265-
* xref:tinymceai-actions-plugin.adoc[Quick Actions]: Content transformation.
264+
* xref:tinymceai-review.adoc[Review]: Content improvement.
265+
* xref:tinymceai-actions.adoc[Quick Actions]: Content transformation.

0 commit comments

Comments
 (0)