Skip to content

Commit 6ed3a99

Browse files
committed
Docs: TinyMCE AI updates from review feedback
- Nav: move legacy AI Assistant under TinyMCE AI; rename plugin nav to Plugin configuration - Introduction: early access messaging, trial/portal, regional LLM note, on-premises partial - Chat: demo before Using Chat; drop redundant screenshot; clarify chat history note - Actions: menu/control ID column; fix table syntax; rename API column for accuracy - Integration options: CDN or self-hosted; hosted AI vs on-premises AI early access - API quick start: remove multi-region Cloud section - Limits, models, options, JWT intro: contact link, model stability note, languages, token provider
1 parent 42d131a commit 6ed3a99

12 files changed

Lines changed: 97 additions & 68 deletions
Binary file not shown.

modules/ROOT/nav.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -254,12 +254,6 @@
254254
** Premium plugins
255255
*** xref:a11ychecker.adoc[Accessibility Checker]
256256
*** xref:advanced-typography.adoc[Advanced Typography]
257-
*** xref:ai.adoc[AI Assistant]
258-
**** xref:ai-openai.adoc[OpenAI ChatGPT integration guide]
259-
**** xref:ai-azure.adoc[Azure AI integration guide]
260-
**** xref:ai-bedrock.adoc[Amazon Bedrock integration guide]
261-
**** xref:ai-gemini.adoc[Google Gemini integration guide]
262-
**** xref:ai-proxy.adoc[AI proxy server reference guide]
263257
*** TinyMCE AI
264258
**** xref:tinymceai-introduction.adoc[Introduction]
265259
**** xref:tinymceai-chat.adoc[Chat]
@@ -268,7 +262,7 @@
268262
**** xref:tinymceai-models.adoc[AI Models]
269263
**** xref:tinymceai-limits.adoc[Limits]
270264
**** xref:tinymceai-integration-options.adoc[Integration Options]
271-
***** xref:tinymceai.adoc[Plugin quick start]
265+
***** xref:tinymceai.adoc[Plugin configuration]
272266
***** REST API
273267
****** xref:tinymceai-api-overview.adoc[API Overview]
274268
****** xref:tinymceai-api-quick-start.adoc[API quick start]
@@ -278,6 +272,12 @@
278272
***** Guides
279273
****** xref:tinymceai-with-jwt-authentication-nodejs.adoc[JWT authentication (Node.js)]
280274
****** xref:tinymceai-with-jwt-authentication-php.adoc[JWT authentication (PHP)]
275+
*** xref:ai.adoc[AI Assistant (legacy)]
276+
**** xref:ai-openai.adoc[OpenAI ChatGPT integration guide]
277+
**** xref:ai-azure.adoc[Azure AI integration guide]
278+
**** xref:ai-bedrock.adoc[Amazon Bedrock integration guide]
279+
**** xref:ai-gemini.adoc[Google Gemini integration guide]
280+
**** xref:ai-proxy.adoc[AI proxy server reference guide]
281281
*** xref:casechange.adoc[Case Change]
282282
*** xref:checklist.adoc[Checklist]
283283
*** Comments

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

Lines changed: 35 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -98,46 +98,64 @@ By default, the Quick Actions feature includes several built-in actions that spe
9898
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].
9999

100100
[[quick-actions-reference-table]]
101-
The following table lists built-in Quick Actions. The **Editor command** column is the menu label. The **API action** column is the identifier: for preview actions it is the `actionName` segment in `+/v1/actions/system/{actionName}/calls+` (see xref:tinymceai-actions-plugin.adoc#actions-api[Actions API]); for Chat commands it is the prompt id used with the xref:tinymceai-chat.adoc[Conversations API], not a system `actionName`. Configure the Translate submenu in the UI with `tinymceai_languages`.
101+
The following table lists built-in Quick Actions. The **Editor command** column is the menu label. The **Menu or control ID** column lists values used in `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]). The **System `actionName` or quick-action prompt id** column is the service identifier: for preview actions it is the `actionName` path segment in `+/v1/actions/system/{actionName}/calls+` (see xref:tinymceai-actions-plugin.adoc#actions-api[Actions API]); for Chat commands it is the built-in quick-action prompt id (`explain`, `summarize`, `highlight-key-points`) used when opening xref:tinymceai-chat.adoc[Chat] with a pre-filled prompt—not a system `actionName` and not sent on the system actions path.
102102

103-
[cols="1,2,4,^,^",options="header"]
103+
[cols="1,3,2,3,1,1",options="header"]
104104
|===
105-
|Editor command |API action |Description |Editor UI |API
105+
|Editor command |Menu or control ID |System `actionName` or quick-action prompt id |Description |Editor UI |API
106106

107-
|**Explain** |`explain` |Opens Chat with the selected text and a pre-filled prompt. Uses the Conversations API, not the system actions path. |✓ |—
107+
|**Explain** |`ai-chat-explain` |`explain` |Opens Chat with the selected text and a pre-filled prompt. Uses the Conversations API, not the system actions path. |✓ |—
108108

109-
|**Summarize** |`summarize` |Opens Chat with a summarize prompt. Uses the Conversations API, not the system actions path. |✓ |—
109+
|**Summarize** |`ai-chat-summarize` |`summarize` |Opens Chat with a summarize prompt. Uses the Conversations API, not the system actions path. |✓ |—
110110

111-
|**Highlight key points** |`highlight-key-points` |Opens Chat with a key-points prompt. Uses the Conversations API, not the system actions path. |✓ |—
111+
|**Highlight key points** |`ai-chat-highlight-key-points` |`highlight-key-points` |Opens Chat with a key-points prompt. Uses the Conversations API, not the system actions path. |✓ |—
112112

113-
|**Improve Writing** |`improve-writing` |Enhance clarity, word choice, and sentence structure. |✓ |✓
113+
|**Improve Writing** |`ai-quickactions-improve-writing` |`improve-writing` |Enhance clarity, word choice, and sentence structure. |✓ |✓
114114

115-
|**Continue Writing** |`continue` |Complete unfinished sentences, paragraphs, or entire documents. |✓ |✓
115+
|**Continue Writing** |`ai-quickactions-continue-writing` |`continue` |Complete unfinished sentences, paragraphs, or entire documents. |✓ |✓
116116

117-
|**Fix Grammar** |`fix-grammar` |Correct grammar, spelling, and punctuation errors. |✓ |✓
117+
|**Fix Grammar** |`ai-quickactions-check-grammar` |`fix-grammar` |Correct grammar, spelling, and punctuation errors. |✓ |✓
118118

119-
|**Adjust length**
120-
a|
121-
`make-shorter` +
122-
`make-longer`
123-
|Shorten or lengthen the selection. Each option is its own system action. |✓ |✓
119+
|**Adjust length** |`ai-quickactions-change-length` |`make-shorter`, `make-longer` |Shorten or lengthen the selection. Each option is its own system action. |✓ |✓
124120

125121
|**Adjust Tone**
126122
a|
123+
`ai-quickactions-change-tone` +
124+
`ai-quickactions-tone-casual` +
125+
`ai-quickactions-tone-direct` +
126+
`ai-quickactions-tone-friendly` +
127+
`ai-quickactions-tone-confident` +
128+
`ai-quickactions-tone-professional`
129+
a|
127130
`make-tone-casual` +
128131
`make-tone-direct` +
129132
`make-tone-friendly` +
130133
`make-tone-confident` +
131134
`make-tone-professional`
132135
|Change writing style; each menu option maps to its own system action. |✓ |✓
133136

134-
|**Translate** |`translate` |Convert content between languages. Request body uses `args: { language: string }` with values such as `english`, `spanish`, `russian`, `swedish`, `german`, `japanese`, `portuguese`, `korean`, `italian`, or `chinese`. Configure the editor submenu with `tinymceai_languages`. |✓ |✓
137+
|**Translate**
138+
a|
139+
`ai-quickactions-translate` +
140+
`ai-quickactions-translate-english` +
141+
`ai-quickactions-translate-spanish` +
142+
`ai-quickactions-translate-russian` +
143+
`ai-quickactions-translate-swedish` +
144+
`ai-quickactions-translate-german` +
145+
`ai-quickactions-translate-japanese` +
146+
`ai-quickactions-translate-portuguese` +
147+
`ai-quickactions-translate-korean` +
148+
`ai-quickactions-translate-italian` +
149+
`ai-quickactions-translate-chinese`
150+
a|
151+
`translate`
152+
|Convert content between languages. Request body uses `args: { language: string }` with values such as `english`, `spanish`, `russian`, `swedish`, `german`, `japanese`, `portuguese`, `korean`, `italian`, or `chinese`. Configure the editor submenu with `tinymceai_languages`. |✓ |✓
135153
|===
136154

137155
[NOTE]
138156
====
139-
* A checkmark in the Editor UI column means the action can appear when included in `tinymceai_quickactions_menu` (and related sub-menu options such as `tinymceai_quickactions_chat_prompts`).
140-
* A checkmark in the API column means the action is invoked through the system Actions API path `+/v1/actions/system/{actionName}/calls+`. An em dash means the command is Chat-based and uses the Conversations API instead.
157+
* A checkmark in the **Editor UI** column means the action can appear when included in `tinymceai_quickactions_menu` (and related sub-menu options such as `tinymceai_quickactions_chat_prompts`).
158+
* A checkmark in the **API** column means the action is invoked through the system Actions API path `+/v1/actions/system/{actionName}/calls+`. An em dash means the command is Chat-based and uses the Conversations API instead.
141159
====
142160

143161
For system action endpoints, schemas, and streaming details, see the https://tinymceai.api.tiny.cloud/docs#tag/Actions[Actions API] reference.

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

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ After signing up, access to the link:{accountpageurl}[customer dashboard (Custom
4242

4343
Log in to the link:{accountpageurl}[Customer Portal] and navigate to link:{accountjwturl}["JWT Keys"].
4444

45-
image::tinymceai/tinymce-ai-customer-portal-jwt-keys-page.png[JWT Keys page showing Secure Keys List, Generate New Keypair, and Import Public Key sections,width=80%]
45+
image::tinymceai/tinymce-ai-customer-portal-jwt-keys-page.png[JWT Keys page showing Secure Keys List, Generate New Keypair, and Import Public Key sections,width=100%]
4646

4747
During the free trial, the demo identity service can provide JWT tokens without creating a custom token endpoint. See xref:tinymceai-jwt-authentication-intro.adoc#trial-demo-identity-service[Trial: demo identity service] in the JWT Authentication guide for a quick start.
4848

@@ -56,11 +56,6 @@ The next step for production is to create a security token endpoint in the appli
5656

5757
To create a custom security token endpoint, generate a keypair in the link:{accountjwturl}[JWT Keys] area of the Customer Portal. In the "Generate New Keypair" section, enter a description, select the key length, and click "Add Key". Alternatively, use "Import Public Key" to add an existing key.
5858

59-
[[cloud-region]]
60-
== Cloud region
61-
62-
Cloud Services can reside in either US or EU region or in both. The region is set per subscription and cannot be changed for existing environments. For Custom plan with multi-region, the region can be chosen during environment creation.
63-
6459
[[api-integration]]
6560
== API Integration
6661

modules/ROOT/pages/tinymceai-chat.adoc

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,15 @@ The Chat feature is available as a plugin UI and through the Conversations API.
1414
* Plugin sections describe user-facing features and configuration (xref:tinymceai.adoc#options-chat[Chat configuration]).
1515
* API sections cover REST API access (starting at xref:tinymceai-chat.adoc#conversations-api[Conversations API]).
1616
17+
[[demo]]
18+
== Demo
19+
20+
liveDemo::tinymceai[]
21+
1722
[[using-chat]]
1823
== Using Chat
1924

20-
image::tinymceai/tinymce-ai-chat-editor-with-ai-chat-sidebar-open.png[{pluginname} Chat interface showing the conversational AI assistant,width=80%]
25+
The <<demo,interactive demo>> above shows the Chat sidebar open beside the document. The following sections describe how Chat behaves in the editor.
2126

2227
[[working-with-the-document]]
2328
=== Working with the document
@@ -36,11 +41,6 @@ Users can chat with the AI and use it to introduce changes to the document. Ask
3641

3742
The chat feature accelerates the creative process. Begin with a blank document and ask the AI for ideas. Build content step by step by chatting and applying changes. Then review or have the AI rewrite the final draft for best results, all in one place.
3843

39-
[[demo]]
40-
== Demo
41-
42-
liveDemo::tinymceai[]
43-
4444
[[integration]]
4545
== Integration
4646

@@ -148,11 +148,6 @@ tinymce.init({
148148

149149
When asking the AI for changes to the document, for instance, _"Bold key facts in the document"_, the AI proposes a series of changes. The changes are displayed directly in the document content, making it easy to see what will be modified.
150150

151-
[NOTE]
152-
====
153-
AI output may need review. The chat interface displays this reminder below the prompt input.
154-
====
155-
156151
[[previewing-changes]]
157152
=== Previewing changes
158153

@@ -193,9 +188,7 @@ Any conversation from the chat history can be continued as long as the AI model
193188

194189
[NOTE]
195190
====
196-
The ability to apply suggestions to the document or generate Suggested Edits from historical conversations may be restricted in some scenarios:
197-
198-
After closing the browser and reopening AI chat, previous conversations will no longer interact with the document content. To continue working with a conversation, reopen it from the chat history.
191+
After starting a new browser session, opening AI Chat does not restore an active link between the editor and a previous conversation's pending suggestions. To apply or dismiss suggestions from an earlier conversation, open that conversation again from Chat history so the editor and the conversation are connected in the current session.
199192
====
200193

201194
[[conversations-api]]

modules/ROOT/pages/tinymceai-integration-options.adoc

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,21 @@
1313

1414
|
1515
[.lead]
16-
xref:tinymceai.adoc[**Plugin Quick Start**]
16+
xref:tinymceai.adoc[**Plugin configuration**]
1717

18-
Integrate AI features directly into the TinyMCE editor interface. Works with CDN or self-hosted TinyMCE installations. A quick way to add AI capabilities to the editor.
18+
Integrate {pluginname} features directly into the {productname} editor interface. Works with the {cloudname} CDN or self-hosted {productname}; both use the hosted AI service with JWT authentication.
1919

2020
|
2121
[.lead]
2222
xref:tinymceai-api-overview.adoc[**AI service**]
2323

2424
Use the AI service API to build custom integrations and workflows. Suitable for server-side processing, custom UI implementations, and advanced use cases. Start with the xref:tinymceai-api-quick-start.adoc[API Quick Start] guide.
2525

26-
|===
26+
|
27+
[.lead]
28+
**On-Premises Deployment**
29+
30+
include::partial$misc/tinymceai-on-premises-early-access-note.adoc[]
31+
32+
a|
33+
|===

modules/ROOT/pages/tinymceai-introduction.adoc

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,22 @@ Teams can implement a full suite of AI writing tools quickly, delivering efficie
2424
The core components of {pluginname} are:
2525

2626
* **xref:introduction-to-tinymce.adoc[{productname}]**: A modern rich text editor with dozens of features that improve writing workflows, including collaboration.
27-
* **xref:tinymceai-api-overview.adoc[AI service]**: A state-of-the-art back-end AI engine that incorporates multiple models and delivers high-quality content. *Currently available in Cloud setup only.* See xref:tinymceai-introduction.adoc#on-premises-deployment[On-Premises Deployment] for deployment options.
27+
* **xref:tinymceai-api-overview.adoc[AI service]**: A state-of-the-art back-end AI engine that incorporates multiple models and delivers high-quality content. *The hosted AI service is currently available in Cloud setup only.*
28+
29+
include::partial$misc/tinymceai-on-premises-early-access-note.adoc[]
2830

2931
[[features]]
3032
== {pluginname} features
3133

32-
There are three main features of {pluginname}. All features can be tested using the free trial.
34+
There are three main features of {pluginname}.
3335

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

40+
[NOTE]
41+
Existing customers on paid plans can request a full featured free trial through the link:{accountpageurl}[Customer Portal].
42+
3843
[[integration-options]]
3944
== Integration Options
4045

@@ -53,10 +58,7 @@ Developers can control access to AI features, models, and capabilities based on
5358

5459
All data stored by {pluginname} follows the region settings of the {productname} Cloud Services environment, ensuring compliance with data residency requirements and optimal performance for the geographic location.
5560

56-
[IMPORTANT]
57-
====
58-
Data sent to LLM providers for processing is currently processed in the US region, regardless of the Cloud Services environment region.
59-
====
61+
NOTE: Data sent to LLM providers for processing is currently handled in the US region, regardless of the Cloud Services environment region. {productname} does not offer separate LLM processing regions to choose from.
6062

6163
[[data-retention-policy]]
6264
=== Data Retention Policy
@@ -77,7 +79,4 @@ All data is encrypted in transit and at rest with end-to-end encryption. Convers
7779

7880
On-premises deployment allows the AI service to run within an organization's infrastructure, giving teams more control over data and infrastructure.
7981

80-
[NOTE]
81-
====
82-
On-premises deployment is currently in development. link:{contactpage}[Contact {supportname}] for availability updates and timeline information.
83-
====
82+
include::partial$misc/tinymceai-on-premises-early-access-note.adoc[]

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ tinymce.init({
237237
plugins: 'tinymceai',
238238
toolbar: 'tinymceai-chat tinymceai-quickactions tinymceai-review',
239239
tinymceai_token_provider: () => {
240-
return fetch('https://example.com/cs-token-endpoint', {
240+
return fetch('http://localhost:3000/jwt', {
241241
method: 'POST',
242242
headers: { 'Content-Type': 'application/json' },
243243
}).then(response => response.json());
@@ -250,8 +250,6 @@ tinymce.init({
250250
The editor will not be ready to use until the first token is obtained from the token endpoint. If an error occurs during the initial request, the editor will not start correctly.
251251
====
252252

253-
For more advanced token request customization, see xref:tinymceai-with-jwt-authentication-nodejs.adoc#configure-tinymce[Configure {productname}] in the implementation guides.
254-
255253
[[token-responses]]
256254
== Responses from the Token Endpoint
257255

modules/ROOT/pages/tinymceai-limits.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This page describes the limits that ensure fair usage, optimal performance, and
1818

1919
Rate limits control the frequency of requests to prevent abuse and ensure service stability. These limits apply to both plugin usage and direct API calls, as the plugin uses the API under the hood. The service implements limits on requests, token usage, web search, and web scraping requests per minute. All rate limits are applied at both organization level (higher limits) and individual user level (lower limits) to ensure fair usage.
2020

21-
NOTE: Specific rate limit values are subject to change and may vary based on the subscription tier. Contact support for current rate limit details for the environment.
21+
NOTE: Specific rate limit values are subject to change and may vary based on the subscription tier. For current rate limit details for the environment, link:{contactpage}[contact {supportname}].
2222

2323
[[context-limits]]
2424
== Context Limits

0 commit comments

Comments
 (0)