Skip to content

DOC-3356: New feature documentation for tinymceai.#3976

Open
kemister85 wants to merge 104 commits intofeature/8.4.0/DOC-3243from
feature/8.4.0/DOC-3356
Open

DOC-3356: New feature documentation for tinymceai.#3976
kemister85 wants to merge 104 commits intofeature/8.4.0/DOC-3243from
feature/8.4.0/DOC-3356

Conversation

@kemister85
Copy link
Copy Markdown
Contributor

@kemister85 kemister85 commented Feb 9, 2026

Ticket: DOC-3356

Revert reminder (temporary CI workaround)

  • Revert commit 8121a0f7b5925f1c7631ac82442fb3ab98e19234 — After DOC-3399 is resolved or a permanent fix is in place, revert this commit so .github/workflows/preview_create.yml returns to the previous trigger set. This commit adds workflow_dispatch (manual preview when automatic runs fail), plus pull_request types edited and ready_for_review. edited also runs on PR title and body edits, which can enqueue extra workflow runs.

  • Revert commit 20a10981fc27b1529071e7f81008c2b563cf3973 — Before merging this PR, revert this commit (or exclude it from the merge) so preview_create.yml is not changed on the target branch unless the team adopts the canonical redirects.json raw URL permanently. This commit switches the redirects input from .../refs/heads/main/redirects.json to .../main/redirects.json to unblock the docs preview workflow when the generate-redirects action cannot fetch the refs/heads URL.

Site: Staging branch

Changes:

TinyMCE AI documentation

Reference and configuration

Other affected pages


Pre-checks:

  • Branch is correctly prefixed: feature/8.4.0/DOC-3356
  • modules/ROOT/nav.adoc has been updated (if applicable).
  • Files have been included where required (if applicable).
  • Files removed have been deleted, not just excluded from the build (if applicable).
  • Files added for New product features include a release note entry.
  • Major or minor version changes have updated the supported-versions.adoc table.
  • Build passes without console errors, warnings, or issues.

Review:

  • Documentation Team Lead has reviewed.

@kemister85 kemister85 added this to the TinyMCE 8.4.0 milestone Feb 9, 2026
@kemister85 kemister85 added the upcoming release Documentation for features currently under development/QA label Feb 9, 2026

* Sign up for one of the link:{pricingpage}[self-service plans], or link:{contactpage}[contact us] to purchase the {pluginname} license.
* Generate access credentials in the link:{accountpageurl}[Customer Portal].
* Write a script that generates one-time tokens for authorizing end users of the application in {productname} Cloud Services (using access credentials created earlier).
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.

May need to reword Write a script as the related section talks about Writing your own token endpoint. I also feel the steps are unclear and disconnected because there is no explanation for why creating and writing a token endpoint. And how can this be used in the plugin configuration?


After setting up the JWT endpoint, continue with:

* xref:tinymceai-api-overview.adoc[API Overview]: Overview of all API features and capabilities.
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.

If the next step is to go over theapi-overview the dev will be stuck in an infinite loop :). Looks like the next step should be to choose the right model?


For detailed event handling examples specific to each service, see:

* xref:tinymceai-chat.adoc#conversations-streaming[Chat]: Text streaming, web search sources, reasoning, and document modifications.
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.

All these links (ref to a streaming section in their respective page) has no useful info except for a link which takes back to this page

kemister85 and others added 13 commits March 27, 2026 14:18
Privacy content remains on the introduction page; the standalone file
was not linked from navigation or other pages.
Co-authored-by: Kim <45845989+kimwoodfield@users.noreply.github.com>
Model permissions in the JWT define which models may be used for the
plugin and API. Plugin and API options only select among allowed
models; document custom Quick Actions and link to permissions.
Token endpoint response handling belongs with tinymceai_token_provider docs; the models page example stays focused on model configuration.
Replace vague 'authoritative for the environment/deployment' phrasing
with explicit language about runtime limits the service applies.
Remove duplicate Event Handling Patterns section, clarify progress
tracking link text, and simplify API reference to the main docs URL.
Co-authored-by: Millie <millie.macdonald@tiny.cloud>
Co-authored-by: Millie <millie.macdonald@tiny.cloud>
Co-authored-by: Millie <millie.macdonald@tiny.cloud>
Co-authored-by: Millie <millie.macdonald@tiny.cloud>
Comment on lines +73 to +77
|**Gemini 3 Pro**
|Google's advanced model for versatile problem-solving and research
|Yes
|Yes
|`'gemini-3-pro'`
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
|**Gemini 3 Pro**
|Google's advanced model for versatile problem-solving and research
|Yes
|Yes
|`'gemini-3-pro'`

There is no 'gemini-3-pro' in the available models' list.

selector: '#editor',
plugins: 'tinymceai',
toolbar: 'tinymceai-chat tinymceai-quickactions tinymceai-review',
tinymceai_default_model: 'claude-3-5-haiku',
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
tinymceai_default_model: 'claude-3-5-haiku',
tinymceai_default_model: 'claude-4-5-haiku',

This is the current model available

Comment on lines +226 to +228
The token endpoint will be requested:
* At editor initialization
* Periodically to refresh the token (typically every hour)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
The token endpoint will be requested:
* At editor initialization
* Periodically to refresh the token (typically every hour)
The token endpoint will be requested:
* At editor initialization
* Periodically to refresh the token (typically every hour)

This is currently being rendered like this:

Image

@kemister85
Copy link
Copy Markdown
Contributor Author

kemister85 commented Mar 27, 2026

One thing I noticed is that because we sort premium plugins alphabetically, old AI plugin is 3rd on the list, but the new one is almost at the end.

Image

I have reused the signup component to feature tinymceai at the top of the premium plugins list. See this commit

image

Comment on lines +56 to +59
=== Writing your own token endpoint

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.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Suggested change
=== Writing your own token endpoint
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.
=== Writing your own token endpoint
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.
Once your keypair is created, use it to sign JWTs in your token endpoint. For step-by-step implementation instructions with complete code examples, see:
* xref:tinymceai-with-jwt-authentication-nodejs.adoc[JWT authentication (Node.js)]: Complete Node.js implementation guide
* xref:tinymceai-with-jwt-authentication-php.adoc[JWT authentication (PHP)]: Complete PHP implementation guide

There are additional steps after generating the keypair to set up the token endpoint. I think we could link to these two pages with the full instruction here like in the Quick setup

…fore styles

Asciidoctor emitted a style-only pass block before the open block, unlike the
signup banner partial. Use one passthrough with markup then style so layout
matches other promo blocks.
Release-notes template placeholders like plugin<s> and improvement<s> were
published as raw angle brackets. Browsers treated <s> as HTML, which broke
sidebar markup site-wide. Correct 8.4.0 nav xrefs to #new-premium-plugins and
#new-open-source-plugin; replace placeholder wording with final copy.
Remove admon-plugins-tinymce-ai-feature partial and include; restore TinyMCE AI
as a table row and prior AI Assistant copy.
Restore partial with single passthrough (markup before inline styles). Include
from premium-plugins; AI Assistant (legacy) row; no duplicate TinyMCE AI table row.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

upcoming release Documentation for features currently under development/QA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants