docs: Adding first draft of JSDocs #4356
Merged
Conversation
This file contains 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
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
@svenadlung this would be ready for review for now. I think the next batch of js docs can come in isolated from this. |
|
@svenadlung could we take a look at this as soon as possible? I spent a bit of time into this and don't want it to draft to far out of sync with the current branch. :) |
svenadlung
previously approved these changes
Dec 20, 2023
|
Fantastic PR here, really helpful! |
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.
Please describe your changes
This PR adds tons of JSDocs for almost all Tiptap extensions excluding the rendering extensions (React, Vue 2 and Vue 3).
This is a draft for now until I feel happy about the amount of jsdocs and will make this PR ready for review as soon as I think we can throw the first batch of jsdocs out there.