docs: Add CLAUDE.md documentation for Tiptap RTE #21103
Merged
+303
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for the Tiptap rich text editor package in the form of a CLAUDE.md file, and corrects a naming inconsistency in the bundle alias. The documentation provides detailed information about the package structure, extension architecture, and development guidelines for working with the Tiptap integration.
Key Changes
- Added detailed CLAUDE.md documentation for the Tiptap package covering architecture, file structure, extension patterns, and usage examples
- Fixed bundle alias from
Umb.Bundle.tiptaptoUmb.Bundle.Tiptapto follow PascalCase naming convention used by all other packages
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/Umbraco.Web.UI.Client/src/packages/tiptap/CLAUDE.md | New comprehensive documentation file describing the Tiptap package structure, extension architecture, file naming conventions, code examples, and quick reference guide |
| src/Umbraco.Web.UI.Client/src/packages/tiptap/umbraco-package.ts | Corrected bundle alias to use PascalCase (Tiptap instead of tiptap), consistent with other package bundle naming conventions |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
iOvergaard
approved these changes
Dec 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Following on from #20841 and #20959, I have added a CLAUDE.md specifically for the Tiptap client module.
Given the integration with the 3rd party APIs of Tiptap and ProseMirror, it felt useful to provide an overview for the module code and structure.