ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add more content everywhere

Browse Source
This commit is contained in:
Hans Pagel
2020-09-15 21:07:16 +02:00
parent 3470400785
commit 17c22b8a2b
8 changed files with 46 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/src/docPages/overview/contributing.md
View File

@@ -1,11 +1,20 @@
# Contributing
Tiptap would be nothing, without its lively community. Contributions have always been and will always be welcome. Here is a little bit you should know, before you send your contributions:
## What kind of contributions are welcome
## What kind of contributions won’t be merged
## How to send your first Pull Request
* Improved documentation, e. g. fixing typos, new sections, further explanation …)
* New features for existing extensions, e. g. a new option
* New extensions, which don’t require changes to the core or other core extensions
* Well explained, non-breaking changes to the core
## Code style
## Testing
There is a eslint config, that ensures a consistent code style. To check for errors, run `$ yarn run lint`. That’ll be checked when you send a pull request. Make sure it’s passing, before sending a pull request.
## Testing
All your pull requests will automatically run all our existing tests. Make sure that they all pass. Run all tests locally with `$ yarn run test` or run single tests (e. g. when writing new ones) with `$ yarn run test:open`.
Any further questions? Create a new issue or discussion in the repository. We’ll get back to you.

3
docs/src/docPages/overview/roadmap.md
View File

@@ -1,3 +0,0 @@
# Roadmap
See https://github.com/ueberdosis/tiptap-next/projects/1

3
docs/src/docPages/overview/sponsoring.md
View File

@@ -1,3 +0,0 @@
# Sponsoring
https://github.com/sponsors/ueberdosis

17
docs/src/docPages/overview/upgrade-guide.md
View File

@@ -1,16 +1,16 @@
# Upgrade Guide
The new API will look pretty familiar too you, but there are a ton of changes though. To make the upgrade a little bit easier, here is everything you need to know:
## Reasons to upgrade to tiptap 2.x
* TypeScript: auto complete, less bugs, generated API documentation
* Amazing documentation with 100+ pages
* Active maintenance, no more updates to 1.x
* Tons of new extensions planned
* Less bugs, tested code based
* autocomplete in your IDE (thanks to TypeScript)
* an amazing documentation with 100+ pages
* active development, new features in the making
* tons of new extensions planned
* well-tested code base
## Upgrading from 1.x to 2.x
The new API will look pretty familiar too you, but there are a ton of changes though. To make the upgrade a little bit easier, here is everything you need to know:
### 1. Explicitly register the Document, Text and Paragraph extensions
Tiptap 1 tried to hide a few required extensions from you. Be sure to explicitly import the [Document](/api/extensions/document), [Paragraph](/api/extensions/paragraph) and [Text](/api/extensions/text) extensions.
@@ -55,3 +55,6 @@ const CustomExtension = …
### 4. Blockquotes must not be nested anymore
:::warning Breaking Change
Currently, blockquotes must not be nested anymore. That said, we’re working on bringing it back. If you use nested blockquotes in your app, don’t upgrade yet.
:::