Skip to content

TINYDOC-3568 - Revitalise the Cloud quick start guides and scope the AI agents page - #4316

Merged
kemister85 merged 17 commits into
tinymce/8from
hotfix/8/TINYDOC-3568_v2
Sep 11, 2026
Merged

TINYDOC-3568 - Revitalise the Cloud quick start guides and scope the AI agents page#4316
kemister85 merged 17 commits into
tinymce/8from
hotfix/8/TINYDOC-3568_v2

Conversation

@kemister85

@kemister85 kemister85 commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Ticket: TINYDOC-3568

Site:

Changes:

Second iteration of the Build with AI work. Based on hotfix/8/TINYDOC-3568 so the diff shows only the changes made in this iteration. Covers the review feedback on #4301 and the feedback gathered on this preview.

New AI quick start guide

  • Adds cloud-quick-start-ai.adoc, an AI-agent path for the Cloud quick start: install the skill, prompt the agent, approve the domain, then configure further against live documentation.
  • The setup step sets expectations for what the skill does rather than showing a generated configuration. Publishing one example configuration would become a maintenance liability against the skill, and it undercuts the point of the page, which is that the skill produces a configuration suited to the project rather than a one-size-fits-all snippet.
  • The "Configure further" step gives the documentation MCP endpoint and the Ask AI widget shortcut inline, so a reader who already knows MCP can connect without leaving the page. The per-agent configuration files remain on the AI agents page.
  • Both quick starts are interlinked at the top so readers landing on either one see the alternative.
  • Linked from installation.adoc and installation-cloud.adoc as a second quick start card, and added to nav.adoc below the existing quick start guide.

AI agents page

  • Scoped ai-coding-agents.adoc to documentation access only: the documentation MCP server, Context7, markdown pages, and llms.txt. The agent skill currently covers Cloud setups only, so the skill material sits on the Cloud AI quick start where the claim holds.
  • The introduction now names all four access methods up front as a linked menu, stating that they are alternatives rather than steps. Read in page order, the sections previously implied a sequence and Context7 arrived as a surprise.
  • Retitled the MCP section to "Connect the TinyMCE documentation MCP server" and split the opening paragraph, which was trying to establish that the server is TinyMCE-specific and distinguish it from the editor's own MCP tool calling in a single sentence.
  • Authentication guidance is agent-neutral; the Claude Code /mcp instruction moved into the Claude Code entry with the other tool-specific advice.
  • Per-agent MCP configuration snippets are collapsed into accordions.
  • Adds a Context7 section.
  • Documents that versioned markdown URLs for the current major version redirect to latest, so an agent retrieving markdown by version number needs to follow redirects. Verified: /docs/tinymce/8/basic-setup/index.md returns 302, /docs/tinymce/7/basic-setup/index.md returns 200.
  • Navigation title is "Connect AI agents to the documentation" so the entry reads as a step within Getting started.

Cloud quick start guide

  • Restructured to four steps: add the script, add the API key, initialize the editor, approve the domain. The API key step moved ahead of initialization so the no-api-key placeholder is explained the first time it appears.
  • The editor example and the live demo now show a representative configuration (19 open-source plugins, a menu bar, and a full toolbar) instead of a bare tinymce.init({selector}). New cloud-quick-start live demo runs the same configuration as the example so the two cannot drift.
  • Adds an "Approve the application domain" step, previously undocumented on this page.
  • That step is a shared partial, partials/install/approve-domain-cloud.adoc, included by both Cloud quick starts so the two cannot diverge.
  • The editor's domain registration notice is quoted as plain text rather than rendered in a warning admonition, which read as a fault on the documentation site rather than a message shown by the editor.
  • "Save the content from the editor" moves into Next steps, gated on productSource so only the two Cloud quick starts change. The npm, zip, php, and dotnet pages render as before.
  • Refreshed the page metadata and description.

Pre-checks:

  • Branch is correctly prefixed
  • 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).
  • Build passes without console errors, warnings, or issues.

Review:

  • Documentation Team Lead has reviewed.

@kemister85
kemister85 requested review from metricjs and noxuhax August 18, 2026 23:46
@kemister85
kemister85 marked this pull request as ready for review August 31, 2026 23:33
@kemister85
kemister85 requested review from a team and soritaheng as code owners August 31, 2026 23:33
@kemister85
kemister85 requested review from MitchC1999, ShiridiGandham and tiny-ben-tran and removed request for a team August 31, 2026 23:33
@kemister85
kemister85 changed the base branch from hotfix/8/TINYDOC-3568 to tinymce/8 September 11, 2026 04:23
@kemister85
kemister85 merged commit 2b49f54 into tinymce/8 Sep 11, 2026
4 checks passed
@kemister85
kemister85 deleted the hotfix/8/TINYDOC-3568_v2 branch September 11, 2026 04:39
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