Decorations api guide #477
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Pull Request Overview
This PR consolidates the CDN installation documentation into the Vanilla JavaScript guide and adds new documentation for the Decorations API. The CDN page is removed and redirected, while the vanilla JavaScript guide is enhanced with CDN usage examples.
- Merged CDN documentation into the Vanilla JavaScript installation guide
- Added comprehensive documentation for the Decorations API
- Updated navigation to include the new Decorations page and remove the standalone CDN page
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/content/editor/sidebar.ts | Added "Decorations" entry to Core Concepts navigation |
| src/content/editor/getting-started/install/vanilla-javascript.mdx | Enhanced content with better explanations and added CDN usage section |
| src/content/editor/getting-started/install/cdn.mdx | Removed standalone CDN page (content merged into vanilla-javascript.mdx) |
| src/content/editor/core-concepts/decorations.mdx | New documentation page explaining Tiptap's Decorations API |
| next.config.mjs | Added permanent redirect from old CDN page to Vanilla JavaScript guide |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| import { Extension, createInlineDecoration } from '@tiptap/core' | ||
|
|
There was a problem hiding this comment.
The imports reference functions that don't exist in the codebase. The helper functions createInlineDecoration, createNodeDecoration, and createWidgetDecoration are documented throughout this file but are not found in the actual Tiptap packages. Either these functions need to be implemented, or the documentation should be updated to show the actual API for creating decorations.
Co-authored-by: Copilot <[email protected]>
Docs for ueberdosis/tiptap#7144