DOC-3356: TBA #3976
DOC-3356: TBA #3976
Conversation
kemister85
added
the
upcoming release
| @@ -0,0 +1,39 @@ | |||
| == Quick Start Guide | |||
|
|
|||
There was a problem hiding this comment.
For all such pages, I'm wondering if it'd be good to add a little context to this section. E.g. "If you don't already have a project, follow these steps to set up a basic environment. If you do, you can skip this section." But better wording. It's somewhat obvious, but could be nice to flag that people can skip if they're not starting from scratch?
|
|
||
| == Generate a Public/Private Key Pair | ||
|
|
||
| include::partial$auth/private-public-key-pairs-for-tiny-cloud-services.adoc[] |
There was a problem hiding this comment.
The headings within this include need to go down a level - currently H2, needs to be H3 so it's within the "Generate a Public/Private Key Pair" heading properly
There was a problem hiding this comment.
Actually, additionally, I think "Generate a key pair locally" and "Add a public key in the JWT Keys section of your account portal" should be under one parent H3, since they're the two steps of that method (of the two methods).
| [[web-search]] | ||
| === Web search | ||
|
|
||
| Web search in Chat allows it to access and retrieve real-time information from the internet. Instead of relying only on pre-trained knowledge, the model can search the web to find up-to-date facts, verify details, and provide more accurate, current answers. Toggle the "Enable web search" button image:https://placehold.net/default.png[Web search icon,24px] for a compatible model to start using the Web search functionality. |
There was a problem hiding this comment.
Flagging that some models use web search of their own volition iirc; whether you need to turn it on manually depends on the model and sometimes even how you word your prompt
| [[reasoning]] | ||
| === Reasoning | ||
|
|
||
| Reasoning in Chat models turns on the ability to think through problems, draw logical conclusions, and make sense of complex information. It enables the model to analyze context, connect ideas, and produce well-structured, coherent answers beyond simple pattern matching. Toggle the "Enable reasoning" button image:https://placehold.net/default.png[Reasoning icon,24px] for a compatible model to start using the Reasoning functionality. |
There was a problem hiding this comment.
Flagging that some models use reasoning of their own volition iirc; whether you need to turn it on manually depends on the model and sometimes even how you word your prompt
| [[model-selection-configuration]] | ||
| === Configuration | ||
|
|
||
| The `tinymceai_conversations_models` configuration property allows you to configure model selection for AI chat. The property lets the integrator set the default model, tailor the available models list, or turn the list off. xref:tinymceai-integration.adoc#supported-ai-models[Learn more about available AI models]. |
There was a problem hiding this comment.
Instead of this kind of nested object, we've got 3 separate config options:
tinymceai_default_modeltinymceai_allow_model_selectiontinymceai_allowed_models
| [[context-configuration]] | ||
| === Configuration | ||
|
|
||
| The `tinymceai_conversations_context` configuration property configures the AI chat menu for adding resources to the prompt context. |
There was a problem hiding this comment.
We've done this differently, since we don't nest objects usually. I'm not sure we even have a setting to configure which options are available - might need to look into that - but we do have the following for integrators to add sources for users to use:
tinymceai_additional_sources_listtinymceai_get_additional_source
There was a problem hiding this comment.
The latter is more about hooking into a repository of custom sources or something I think
| ---- | ||
|
|
||
| [[working-with-ai-generated-changes]] | ||
| == Working with AI-generated changes |
There was a problem hiding this comment.
This is where our UI differs the most I think. Showing changes and Previewing is a single toggle, and we lean on showing changes in the content rather than the chat. This section could probably be simplified a lot thanks to that.
| [[review-commands]] | ||
| == Review commands | ||
|
|
||
| The feature comes with several review commands: |
There was a problem hiding this comment.
We currently don't support custom commands or translation. That may change, but.
|
|
||
| Actions are fast, stateless operations that transform content directly. Unlike Reviews that provide suggestions, Actions immediately modify your content based on the selected operation. | ||
|
|
||
| **When to use Actions vs Reviews:** Use Actions when you need to transform specific text content (fix grammar, translate, adjust tone). Use Reviews when you need to analyze entire documents for quality improvements and get suggestions without automatically changing the content. |
There was a problem hiding this comment.
Same as before - Instead of "specific text content" should we say something like a selection or a small section or something? Since Quick Actions work on selections specifically.
| :description_short: quick actions feature | ||
| :keywords: AI, quick actions, actions, tinymceai | ||
|
|
||
| Quick actions streamline routine content transformations by offering one-click AI-powered suggestions directly within the editor. You can also ask questions about your selected text in AI chat to get instant AI insights and analysis. This feature enhances speed, relevance, and usability, particularly for repeatable or simple tasks. The feature comes with an easy-to-use window interface but can also act as a conversation starter with the xref:tinymceai-chat.adoc[Chat]. |
There was a problem hiding this comment.
| Quick actions streamline routine content transformations by offering one-click AI-powered suggestions directly within the editor. You can also ask questions about your selected text in AI chat to get instant AI insights and analysis. This feature enhances speed, relevance, and usability, particularly for repeatable or simple tasks. The feature comes with an easy-to-use window interface but can also act as a conversation starter with the xref:tinymceai-chat.adoc[Chat]. | |
| Quick actions streamline routine content transformations by offering one-click AI-powered suggestions directly within the editor. This feature enhances speed, relevance, and usability, particularly for repeatable or simple tasks. The feature comes with an easy-to-use window interface but can also act as a conversation starter with the xref:tinymceai-chat.adoc[Chat]. |
that sentence is about chat, not quick actions.
|
|
||
| To start using the Quick Actions feature, first load the TinyMCE AI plugin in your editor configuration. xref:tinymceai-integration.adoc[Learn more about installing and enabling AI features]. | ||
|
|
||
| Then, you can add the menu that opens the list of Quick Actions (`tinymceai-actions`) image:https://placehold.net/default.png[Quick Actions icon,24px] to your main toolbar and/or balloon toolbar configurations. To learn more about toolbar configuration, refer to the xref:toolbar-configuration-options.adoc[toolbar configuration] guide. |
There was a problem hiding this comment.
Is "balloon toolbar" the equiv of our context toolbars? I assume so. Also want to check if we add the AI features to the selection toolbar by default if the plugin is enabled - Idk if we're doing that currently
|
|
||
| * Some actions, for instance, "Ask AI" or "Summarize", lead to the xref:tinymceai-chat.adoc[Chat] interface with selected text added as context. The former will just open the Chat and allow you to start typing your message. The latter, however, will not only open the Chat but also start the conversation for your current editor selection right away, and expect a summary of that selection from the AI. | ||
|
|
||
| * Executing other actions like "Continue writing" or "Make shorter" will open the window interface conveniently right next to your selection and present the answers from the AI for you to accept or reject them. |
There was a problem hiding this comment.
pretty sure our UI ended up being a bit different for this
| ---- | ||
|
|
||
| [[removing-default-actions]] | ||
| == Removing default actions |
There was a problem hiding this comment.
we let people configure the list instead of them having to specify which to remove. option is. tinymceai_quickactions_menu for the main menu, then any sub menus have their own option (tone, length, etc)
| [[custom-actions]] | ||
| == Custom Actions | ||
|
|
||
| The `tinymceai_actions_extraCommands` configuration property allows you to add new commands to the Quick actions feature. Below, you will find an example of three extra actions added to the user interface: two of them open the quick actions window, but the last one interacts with AI chat. Learn more about xref:tinymceai-actions-plugin.adoc#types-of-actions[types of actions]. |
There was a problem hiding this comment.
tinymceai_custom_commands
| [[previewing-changes]] | ||
| === Previewing changes | ||
|
|
||
| Click the "Show in the text" button image:https://placehold.net/default.png[Show in the text icon,24px] to display the information window about an individual change with options to apply it or turn it into a Suggested Edits suggestion. You can use this window to browse all proposed changes and work with them one by one. As you navigate through the changes, the window will automatically follow the corresponding sections of the document. |
There was a problem hiding this comment.
we don't integrated with Suggested Edits yet
| image::https://placehold.net/default.png[TinyMCE AI Chat apply all changes] | ||
|
|
||
| [[inserting-suggested-edits]] | ||
| === Inserting Suggested Edits suggestions |
There was a problem hiding this comment.
we don't integrate with suggested edits yet
|
|
||
| === Quick actions and content markers issues | ||
|
|
||
| Applying quick action responses may result in the loss of Comments and Suggested Edits suggestion markers. This issue will be addressed in a future update. |
There was a problem hiding this comment.
need to check with QA how their testing went with this
|
|
||
| [NOTE] | ||
| ==== | ||
| Using AI features with the Suggested Edits feature requires proper user configuration. Learn more about the xref:tinymceai-integration.adoc#suggested-edits-dependency[Suggested Edits dependency] or refer to the xref:tinymceai-integration.adoc#sample-implementation[sample implementation] for more details. |
There was a problem hiding this comment.
we don't integrate with suggested edits yet
|
|
||
| [NOTE] | ||
| ==== | ||
| You must configure a user interface type for the AI features to work. Learn more about the available options in the xref:tinymceai-integration.adoc#ui-types-and-positioning[UI placement] section or use the xref:tinymceai-integration.adoc#sample-implementation[sample implementation] as a reference. |
There was a problem hiding this comment.
we've limited UI options to just the two sidebar types - can simplify
| [[sample-implementation]] | ||
| == Sample implementation | ||
|
|
||
| An example TinyMCE AI configuration is presented below. You can learn more about specific configurations such as xref:tinymceai-integration.adoc#ui-types-and-positioning[UI types and positioning] or xref:tinymceai-integration.adoc#suggested-edits-dependency[Suggested Edits dependency] in the later sections of this guide. |
There was a problem hiding this comment.
positiong and suggested edits both aren't relevant right now.
| To learn more about toolbar configuration, refer to the xref:toolbar-configuration-options.adoc[toolbar configuration] guide. | ||
|
|
||
| [source,js] | ||
| ---- |
There was a problem hiding this comment.
we can make this so much simpler. how complex do we want it to be? e.g. show off all the settings? could still make it simpler than what it currently is
| }, | ||
|
|
||
| // ⚠️ Mandatory UI configuration. | ||
| // Display the AI user interface in a dedicated DOM element. The interface can be also displayed |
There was a problem hiding this comment.
don't need this - it just goes in the sidebar
| ==== | ||
|
|
||
| [[suggested-edits-dependency]] | ||
| === Suggested Edits dependency |
There was a problem hiding this comment.
we don't integrate with suggested edits yet - remove section
| ==== | ||
|
|
||
| [[ui-types-and-positioning]] | ||
| === UI types and positioning |
There was a problem hiding this comment.
we just have two sidebar types - static or floating - set by the config option tinymceai_sidebar_type . can simplify this section a lot
There was a problem hiding this comment.
sidebar = sidebar, overlay = floating
| Learn how to xref:tinymceai-integration.adoc#toggling-the-ui[toggle the AI overlay] using a dedicated toolbar button. | ||
|
|
||
| [[custom]] | ||
| ==== Custom |
There was a problem hiding this comment.
we don't support this (yet)
|
|
||
| [source,js] | ||
| ---- | ||
| // Show the AI interface |
There was a problem hiding this comment.
we just have one command - tinymceai-toggle-sidebar (name may yet get camelcased)
| [[toggling-the-ui]] | ||
| === Toggling the UI | ||
|
|
||
| The user interface can be easily toggled by the users using the `'tinymceai-toggle'` image:https://placehold.net/default.png[Ask AI icon,24px] toolbar button. The button becomes available for configuration when the AI features are enabled. |
There was a problem hiding this comment.
when you click the toolbar button (or the menu item I guess) it opens or minimises the relevant AI sidebar.
- click the chat toolbar button, chat opens. click it again, chat minimises (importantly: it doesn't wipe the chat history, just hides the sidebar)
- click the chat toolbar button, chat opens. click the review button, review sidebar opens.
etc.
if you're in the middle of reviewing suggested changes, the sidebar can be minimised to give you more screen space for reviewing. once done reviewing, you can open the sidebar again to keep working.
| [[hiding-the-ui-on-initialization]] | ||
| === Hiding the UI on initialization | ||
|
|
||
| By default, the AI interface will be visible when editor is created (and the xref:tinymceai-integration.adoc#toggling-the-ui[related toolbar button] will be active). If you wish to have it hidden until the user opens it (e.g. via toolbar button), set `tinymceai_ui_visible_by_default` property to `false`. |
There was a problem hiding this comment.
need to check, but I think we actually do the opposite. need to use the command or something if you want it to show on load.
| ---- | ||
|
|
||
| [[maximizing-the-ui]] | ||
| === Maximizing the UI |
There was a problem hiding this comment.
not supported - delete section
| To setup the {pluginname} plugin in the editor: | ||
|
|
||
| * add `{plugincode}` to the `plugins` option in the editor configuration; | ||
| * add `{plugincode}` to the `toolbar` option in the editor configuration; |
There was a problem hiding this comment.
we'll have ~3 toolbar buttons, not one, for the different features
|
|
||
| * add `{plugincode}` to the `plugins` option in the editor configuration; | ||
| * add `{plugincode}` to the `toolbar` option in the editor configuration; | ||
| * configure the `tinymceai_token_provider` option to provide authentication tokens; |
There was a problem hiding this comment.
I'd move this up a line since it's more required than toolbar buttons? nitpick
2 participants
Ticket: DOC-3356
Site: tinymceai-introduction
Site: Integration Options: installation path
Site: tinymceai-with-jwt-authentication-nodejs/
will require testing and updatesSite: tinymceai-with-jwt-authentication-php/
will require testing and updatesChanges:
tinymceaiPre-checks:
feature/<version>/,hotfix/<version>/,staging/<version>/, orrelease/<version>/.modules/ROOT/nav.adochas been updated(if applicable).release noteentry for anyNew product features.productminorversioninantora.ymland added new supported versions entry inmodules/ROOT/partials/misc/supported-versions.adoc.Review: