Skip to content

Commit 01b2946

Browse files
committed
DOC-3468: Address PR feedback — custom reviews ship by default
- Remove explicit tinymceai_reviews from all 4 demo files (default config) - Simplify Custom review table row and NOTE (no qualifier needed) - Apply wording suggestion for quickbars custom action note - Reword Custom review section as default rather than conditional
1 parent 62ec64f commit 01b2946

6 files changed

Lines changed: 5 additions & 37 deletions

File tree

modules/ROOT/examples/live-demos/full-featured/example.js

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -524,14 +524,6 @@ tinymce.init({
524524
};
525525
return Promise.resolve({ type: 'web-resource', url: urls[id] });
526526
},
527-
tinymceai_reviews: [
528-
'ai-reviews-proofread',
529-
'ai-reviews-improve-clarity',
530-
'ai-reviews-improve-readability',
531-
'ai-reviews-change-length',
532-
'ai-reviews-change-tone',
533-
'ai-reviews-custom'
534-
],
535527
tinymceai_quickactions_custom: [
536528
{
537529
type: 'chat',

modules/ROOT/examples/live-demos/full-featured/index.js

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -514,14 +514,6 @@ tinymce.init({
514514
};
515515
return Promise.resolve({ type: 'web-resource', url: urls[id] });
516516
},
517-
tinymceai_reviews: [
518-
'ai-reviews-proofread',
519-
'ai-reviews-improve-clarity',
520-
'ai-reviews-improve-readability',
521-
'ai-reviews-change-length',
522-
'ai-reviews-change-tone',
523-
'ai-reviews-custom'
524-
],
525517
tinymceai_quickactions_custom: [
526518
{
527519
type: 'chat',

modules/ROOT/examples/live-demos/tinymceai-review/example.js

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,6 @@ tinymce.init({
2727
};
2828
return Promise.resolve({ type: 'web-resource', url: urls[id] });
2929
},
30-
tinymceai_reviews: [
31-
'ai-reviews-proofread',
32-
'ai-reviews-improve-clarity',
33-
'ai-reviews-improve-readability',
34-
'ai-reviews-change-length',
35-
'ai-reviews-change-tone',
36-
'ai-reviews-custom'
37-
],
3830
tinymceai_quickactions_custom: [
3931
{
4032
type: 'chat',

modules/ROOT/examples/live-demos/tinymceai-review/index.js

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -92,14 +92,6 @@ tinymce.init({
9292
};
9393
return Promise.resolve({ type: 'web-resource', url: urls[id] });
9494
},
95-
tinymceai_reviews: [
96-
'ai-reviews-proofread',
97-
'ai-reviews-improve-clarity',
98-
'ai-reviews-improve-readability',
99-
'ai-reviews-change-length',
100-
'ai-reviews-change-tone',
101-
'ai-reviews-custom'
102-
],
10395
tinymceai_quickactions_custom: [
10496
{ type: 'chat', title: 'Challenge', prompt: 'Challenge statements, verify facts and identify assumptions' }
10597
],

modules/ROOT/pages/tinymceai-actions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ tinymce.init({
8383

8484
[NOTE]
8585
====
86-
AI controls are not added to the xref:quickbars.adoc#quickbars_selection_toolbar[`+quickbars_selection_toolbar+`] automatically; add the desired toolbar button identifiers to that option when they should appear there. Custom actions that define an xref:tinymceai.adoc#tinymceai_quickactions_custom[`+id+`] can also be listed in `+quickbars_selection_toolbar+`.
86+
AI controls are not added to the xref:quickbars.adoc#quickbars_selection_toolbar[`+quickbars_selection_toolbar+`] automatically; add the desired toolbar button identifiers to that option when they should appear there. Custom actions defined by xref:tinymceai.adoc#tinymceai_quickactions_custom[`+id+`] can also be listed in `+quickbars_selection_toolbar+`.
8787
8888
For example:
8989

modules/ROOT/pages/tinymceai-review.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,22 +67,22 @@ Built-in system reviews are listed below. The **Editor** column is the label in
6767

6868
|**Adjust tone and style** |Tone Adjustment |Adjust tone and style. The editor includes _Casual_, _Direct_, _Friendly_, _Confident_, and _Professional_ options. |✓ |✓
6969

70-
|**Custom review** |— |xref:tinymceai-review.adoc#custom-review-choose-review[Custom review]: custom prompt and model; streams like other reviews. |✓ (when `+'ai-reviews-custom'+` is in xref:tinymceai.adoc#tinymceai_reviews[`tinymceai_reviews`]) |✓ (custom review calls endpoint)
70+
|**Custom review** |— |xref:tinymceai-review.adoc#custom-review-choose-review[Custom review]: custom prompt and model; streams like other reviews. |✓ |✓ (custom review calls endpoint)
7171

7272
| |Translation |Translate between languages with cultural adaptation. | |✓
7373
|===
7474

7575
[NOTE]
7676
====
7777
* A checkmark in the Editor UI column means that review type can appear in the Review sidebar when it is listed in xref:tinymceai.adoc#tinymceai_reviews[`tinymceai_reviews`].
78-
* xref:tinymceai-review.adoc#custom-review-choose-review[Custom review] in the Review sidebar is available when `+'ai-reviews-custom'+` is included in xref:tinymceai.adoc#tinymceai_reviews[`tinymceai_reviews`]. The xref:tinymceai-review.adoc#reviews-custom-reviews[Custom reviews (API)] section describes the REST endpoint used for the same streaming review flow.
78+
* xref:tinymceai-review.adoc#custom-review-choose-review[Custom review] is included in the Review sidebar by default. The xref:tinymceai-review.adoc#reviews-custom-reviews[Custom reviews (API)] section describes the REST endpoint used for the same streaming review flow.
7979
* Translation Review is API-only (not listed in the Review sidebar); see the xref:tinymceai-review.adoc#built-in-reviews[Translation row] in the table above. For translation from the editor, see **Translate** in xref:tinymceai-actions.adoc#quick-actions-reference-table[Quick Actions reference table].
8080
====
8181

8282
[[custom-review-choose-review]]
8383
== Custom review
8484

85-
When `+'ai-reviews-custom'+` is present in xref:tinymceai.adoc#tinymceai_reviews[`tinymceai_reviews`], the Review sidebar includes a **Custom review** category. A natural-language prompt can be entered, and an AI model can be selected when xref:tinymceai.adoc#tinymceai_allow_model_selection[`tinymceai_allow_model_selection`] allows it; the review runs from **Run**. The document is analyzed with streaming suggestions like xref:tinymceai-review.adoc#review-sidebar-and-built-in-reviews[built-in reviews]; **Run** remains disabled until the prompt is entered and a model is selected.
85+
The Review sidebar includes a **Custom review** category by default. A natural-language prompt can be entered, and an AI model can be selected when xref:tinymceai.adoc#tinymceai_allow_model_selection[`tinymceai_allow_model_selection`] allows it; the review runs from **Run**. The document is analyzed with streaming suggestions like xref:tinymceai-review.adoc#review-sidebar-and-built-in-reviews[built-in reviews]; **Run** remains disabled until the prompt is entered and a model is selected. To hide Custom review, remove `+'ai-reviews-custom'+` from xref:tinymceai.adoc#tinymceai_reviews[`tinymceai_reviews`].
8686

8787
[TIP]
8888
The backend uses the custom review call (`POST /v1/reviews/custom/calls`) with `content`, `prompt`, and `model` in the request body. After a run completes, **Retry** in the Review UI can re-run the last review with the same parameters for both system and custom reviews.
@@ -117,7 +117,7 @@ Integrators can also call the Custom Review API endpoint directly. It streams su
117117

118118
See https://tinymceai.api.tiny.cloud/docs#tag/Reviews[Reviews API] for the endpoint, parameters, and examples.
119119

120-
Users can run the same style of custom review from the editor when xref:tinymceai-review.adoc#custom-review-choose-review[Custom review] is enabled through xref:tinymceai.adoc#tinymceai_reviews[`tinymceai_reviews`].
120+
Users can also run custom reviews directly from the editor through the xref:tinymceai-review.adoc#custom-review-choose-review[Custom review] category in the Review sidebar.
121121

122122
Custom reviews require the `ai:reviews:custom` permission in the JWT token.
123123

0 commit comments

Comments
 (0)