-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Add agent skill for Tiptap integration #7619
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+57
−0
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1ef36a4
feat: add agent skill for tiptap integration
arnaugomez fd73da7
fix: prefix doc references with tiptap-docs/ in agent skill
arnaugomez 3d6fcf9
fix: rename agent skill from tiptap-integration to tiptap
arnaugomez caa8c4c
fix: remove Node.js from skill compatibility requirements
arnaugomez ade4b21
fix: use correct src/content paths for doc references in agent skill
arnaugomez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| name: tiptap | ||
| description: Helps coding agents integrate and work with the Tiptap rich text editor. Use when building or modifying a rich text editor with Tiptap, installing Tiptap extensions, or implementing features like collaboration, comments, AI, or document conversion. | ||
| compatibility: Requires git | ||
| metadata: | ||
| author: tiptap | ||
| version: "1.0" | ||
| --- | ||
|
|
||
| # Tiptap Integration Skill | ||
|
|
||
| Instructions for coding agents integrating the Tiptap rich text editor | ||
|
|
||
| ## Reference Repositories | ||
|
|
||
| Clone the tiptap and tiptap-docs repositories so you can search the source code and documentation. | ||
| - https://github.com/ueberdosis/tiptap | ||
| - https://github.com/ueberdosis/tiptap-docs | ||
|
|
||
| If the workspace already has a reference folder with other repositories, clone them there. | ||
|
|
||
| Otherwise, clone the repositories in a new `.reference` folder. The reference folder should be git-ignored. | ||
|
|
||
| Before you start a task, make sure the repositories are updated to the latest version. | ||
|
|
||
| ## Best Practices | ||
|
|
||
| ### General | ||
|
|
||
| - Use the latest stable version of **Tiptap 3**. | ||
| - All packages that start with `@tiptap/` must have the **same version number**. | ||
| - When integrating Tiptap for the first time, read the corresponding installation guide in tiptap-docs. | ||
| - When server-side rendering (e.g. Next.js), set the `immediatelyRender: false` option when initializing the editor. Otherwise, the editor will crash. Learn more about this in tiptap-docs. | ||
|
|
||
| ### React | ||
|
|
||
| - Prefer using the React Composable API. See `tiptap-docs/src/content/guides/react-composable-api.mdx` | ||
|
|
||
| ## Implementing Editor Features | ||
|
|
||
| When the user asks you to implement one of these features, read the corresponding section in tiptap-docs for guidance. | ||
|
|
||
| - **Real-time collaboration** — Multiple users editing a document simultaneously. See `tiptap-docs/src/content/collaboration/`. | ||
| - **Comments** — Thread-based inline and document comments. See `tiptap-docs/src/content/comments/`. | ||
| - **Tracked changes** — Track, accept, and reject document edits. See `tiptap-docs/src/content/tracked-changes/`. | ||
| - **Import/Export** — Convert documents to and from DOCX, PDF, Markdown, and other formats. See `tiptap-docs/src/content/conversion/`. | ||
| - **AI content generation** — Generate text content into the document using AI. See `tiptap-docs/src/content/content-ai/capabilities/ai-toolkit/workflows/insert-content.mdx`. | ||
| - **AI agent document editing** — Give an AI agent the ability to edit Tiptap documents. See `tiptap-docs/src/content/content-ai/capabilities/ai-toolkit/`. | ||
| - **AI review and proofreading** — Review, proofread, and suggest style improvements. See `tiptap-docs/src/content/content-ai/capabilities/ai-toolkit/workflows/proofreader.mdx`. | ||
| - **AI server-side processing** — Run AI workflows that edit rich text documents on the server. See `tiptap-docs/src/content/content-ai/capabilities/server-ai-toolkit/`. | ||
| - **Version history** — Save and restore document snapshots. See `tiptap-docs/src/content/collaboration/documents/snapshot.mdx`. | ||
| - **Snapshot compare** — Highlight differences between document versions. See `tiptap-docs/src/content/collaboration/documents/snapshot-compare.mdx`. | ||
| - **Pages** — Print-ready page layout with headers, footers, and page breaks. See `tiptap-docs/src/content/pages/`. | ||
|
|
||
| ## Pro Extensions | ||
|
|
||
| Some Tiptap extensions are distributed through a private npm registry. To install pro packages, see `tiptap-docs/src/content/guides/pro-extensions.mdx` for setup instructions. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.