Skip to content

Document Tiptap version policy for richtext extensions - #840

Open
alvarosabu wants to merge 1 commit into
mainfrom
docs/tiptap-version-policy
Open

alvarosabu wants to merge 1 commit into
mainfrom
docs/tiptap-version-policy

Conversation

@alvarosabu

Copy link
Copy Markdown
Contributor

Summary

  • Add the Rich Text Extensions page at /guides/extensions/app-extensions/richtext. It has the Tiptap Version Policy section:
    • Why extensions use the Data Studio's copy of Tiptap and ProseMirror.
    • The shared Tiptap packages, and how the extensions SDK handles changeset, inputrules, and bare prosemirror-* imports.
    • The version guarantee: Directus 12.x ships Tiptap 3.x. A new Tiptap major version ships only in a new Directus major version.
    • How to set the host range, and what the Marketplace shows when it does not match.
    • What authors do after a Tiptap major upgrade.
  • Add a Rich Text card to the App Extensions overview.
  • Link to the policy from the Next Steps section of the data model Rich Text page.
  • Rename 7.ui-library.md to 8.ui-library.md and 8.composables.md to 9.composables.md. This sorts Rich Text with the other extension types. The URLs do not change.

This page covers the version policy only. CMS-3098 adds the full API documentation.

Depends on

Open items

Test plan

  • Open /docs/guides/extensions/app-extensions/richtext and check the page renders.
  • Open /docs/guides/extensions/app-extensions and check the Rich Text card links to the new page.
  • Open /docs/guides/data-model/rich-text#next-steps and check the #tiptap-version-policy link scrolls to the section.
  • Check that /docs/guides/extensions/app-extensions/ui-library and /docs/guides/extensions/app-extensions/composables still load.

Closes CMS-3088

- Introduced a new guide for Rich Text Extensions, detailing how to add Tiptap nodes, marks, and toolbar buttons to the WYSIWYG interface.
- Updated the app extensions index to include a link to the new Rich Text guide.
- Added a new guide for the UI Library, outlining reusable UI components available for building extensions.
- Created a comprehensive guide on Vue composables for interacting with Directus services, enhancing the developer experience for extension building.
@vercel

vercel Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 7, 2026 8:53am UTC

Request Review

@linear-code

linear-code Bot commented Oct 7, 2026

Copy link
Copy Markdown

CMS-3088

@alvarosabu
alvarosabu marked this pull request as ready for review October 7, 2026 12:53
@alvarosabu
alvarosabu requested a review from a team as a code owner October 7, 2026 12:53
@ChristopherJennings ChristopherJennings mentioned this pull request Oct 7, 2026
3 tasks done

This branch was successfully deployed

1 active deployment
Preview — 3724a296 Deployed Oct 7, 2026 by vercel[bot]
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.

1 participant