Skip to content

DOC-3468 - Document TinyMCE AI 8.5 custom reviews, commands, and quickbars integration#4070

Open
kemister85 wants to merge 4 commits intofeature/8.5.0/DOC-3355from
feature/8.5.0/DOC-3355_DOC-3468
Open

DOC-3468 - Document TinyMCE AI 8.5 custom reviews, commands, and quickbars integration#4070
kemister85 wants to merge 4 commits intofeature/8.5.0/DOC-3355from
feature/8.5.0/DOC-3355_DOC-3468

Conversation

@kemister85
Copy link
Copy Markdown
Contributor

@kemister85 kemister85 commented Apr 16, 2026

Ticket: DOC-3468

Site:

Changes:

  • tinymceai_options.adoc — Added ai-reviews-custom to tinymceai_reviews option with new default value; added id property to tinymceai_quickactions_custom with examples for tinymceai_quickactions_menu, quickbars_selection_toolbar, and menu configurations
  • tinymceai-review.adoc — Added Custom review section for the Review sidebar; updated Built-in reviews table with custom review row; improved section headings and wording
  • tinymceai-cmds.adoc — Documented all new Quick Action commands, TinyMCEAIQuickActionTranslate (language arg), TinyMCEAIQuickActionCustom (prompt/model), and TinyMCEAIChatPrompt (prompt/displayedPrompt); added ToggleSidebar usage for floating sidebars; removed undocumented TinyMCEAIDiagnostic
  • editor-command-identifiers.adoc — Updated TinyMCE AI section intro to reflect new command types
  • tinymceai-actions.adoc — Added note about custom action id usage in quickbars_selection_toolbar
  • tinymceai.adoc — Removed empty trailing lines
  • Live demos (full-featured and tinymceai-review, both example.js and index.js) — Added explicit tinymceai_reviews array including ai-reviews-custom
  • Review sidebar screenshot — Updated to show custom review category

Pre-checks:

  • Branch is correctly prefixed: feature/8.5.0/DOC-3355_DOC-3468
  • modules/ROOT/nav.adoc has been updated (if applicable). — N/A, no new pages
  • Files have been included where required (if applicable).
  • Files removed have been deleted, not just excluded from the build (if applicable). — N/A
  • Files added for New product features include a release note entry. — Release notes handled by DOC-3355
  • Major or minor version changes have updated the supported-versions.adoc table. — N/A
  • Build passes without console errors, warnings, or issues.

Review:

  • Documentation Team Lead has reviewed.

@kemister85 kemister85 requested review from a team and soritaheng as code owners April 16, 2026 00:38
@kemister85 kemister85 changed the base branch from tinymce/8 to feature/8.5.0/DOC-3355 April 16, 2026 00:47
…bars integration

- Add tinymceai_reviews option with ai-reviews-custom for custom review
- Document all new Quick Action commands and TinyMCEAIChatPrompt
- Add id property to tinymceai_quickactions_custom for toolbar/menu/quickbars use
- Update full-featured and tinymceai-review demos with explicit tinymceai_reviews
- Update editor-command-identifiers and tinymceai-actions for quickbars integration
- Remove undocumented TinyMCEAIDiagnostic command
- Update review sidebar screenshot
@kemister85 kemister85 force-pushed the feature/8.5.0/DOC-3355_DOC-3468 branch from 2ec0b88 to 8c99741 Compare April 16, 2026 01:59
Comment thread antora.yml
cdnurl: https://cdn.tiny.cloud/1/no-api-key/tinymce/8/tinymce.min.js
tdcdnurl: https://cdn.tiny.cloud/1/_your_api_key_/tinydrive/8/tinydrive.min.js
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8/tinymce.min.js
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8-dev/tinymce.min.js
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Revert before merging
Suggested change
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8-dev/tinymce.min.js
tinymce_live_demo_url: https://cdn.tiny.cloud/1/qagffr3pkuv17a8on1afax661irst1hbr4e6tbv888sz91jc/tinymce/8/tinymce.min.js

Comment thread modules/ROOT/examples/live-demos/full-featured/example.js Outdated
Comment thread modules/ROOT/pages/tinymceai-actions.adoc Outdated
Comment thread modules/ROOT/pages/tinymceai-review.adoc Outdated
Comment thread modules/ROOT/pages/tinymceai-review.adoc Outdated
[[custom-review-choose-review]]
== Custom review

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Asked the devs a question to clarify this. Waiting on response.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted — waiting on the dev response before making further changes to this section.

- 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
@kemister85
Copy link
Copy Markdown
Contributor Author

The TINY-14229 change (new optional id property for tinymceai_quickactions_custom) has been covered in the release notes: #4081

@kemister85
Copy link
Copy Markdown
Contributor Author

The TINY-14266 change (new commands for executing AI UI actions) has been covered in the release notes: #4082

[[tinymceai-floating-sidebar-api]]
=== Floating sidebar and `+ToggleSidebar+`

When xref:tinymceai.adoc#tinymceai_sidebar_type[`tinymceai_sidebar_type`] is `+'floating'+`, the core `+ToggleSidebar+` command, the `+ToggleSidebar+` event, and `+queryCommandValue('ToggleSidebar')+` work the same as for a static sidebar for `+'tinymceai-chat'+` and `+'tinymceai-review'+`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we even need to include this info I treated it more like a bug that we didn't fully support this API but maybe we could have general notes or some example on how to deal with these events and the query state in general not specifically for floating sidebars?


[NOTE]
====
Command names use the `+TinyMCEAIQuickActions…+` prefix (with an `+s+`) for **Explain**, **Summarize**, and **Highlight key points** — these map to the xref:tinymceai.adoc#tinymceai_quickactions_chat_prompts[chat prompts] submenu, not to standalone `+TinyMCEAIQuickAction…+` spellings.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, right I wonder if this will be confusing not to have the s suffix but then again executing a command like TinyMCEAIQuickActionsCustom could be interpreted that you are executing multiple quick actions when we are just executing one. 🤔

* `+prompt+`: The prompt sent to the AI
* `+type+`: `+'action'+` or `+'chat'+`
* `+model+`: Required for `+action+` type only
* `+id+` (optional): Stable identifier for the custom action. When set, the same string can be listed in xref:tinymceai.adoc#tinymceai_quickactions_menu[`tinymceai_quickactions_menu`] so the action appears as its own top-level menu item instead of only inside the Custom submenu. The identifier can also be used in xref:quickbars.adoc#quickbars_selection_toolbar[`+quickbars_selection_toolbar+`], the xref:menus-configuration-options.adoc#menu[`+menu+`] option, or any other toolbar or menu configuration that accepts control identifiers.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's actually only menu items. So the id makes it possible to use the custom menu item in any place we expect menu ids.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants