Skip to content
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

Improve documentation on how to create an extension #2231

Open
villesau opened this issue Dec 26, 2023 · 0 comments
Open

Improve documentation on how to create an extension #2231

villesau opened this issue Dec 26, 2023 · 0 comments
Labels
type: bug 🪲 Something isn't working

Comments

@villesau
Copy link

villesau commented Dec 26, 2023

Summary

Now the documentation only lists what extensions are possible: https://remirror.io/docs/advanced/creating-extensions

It would make sense to have a step by step guide to create a simple extension too. It could go through crucial methods and the purpose decorators etc. Now when copying some simple extension to editor, all the decorators tend to give plenty of type errors which makes them harder to grasp.

I believe that by fixing docs around extension could help to get external contributors to reduce pressure from core maintainers as more people could fix bugs and improve the framework.

@villesau villesau added the type: bug 🪲 Something isn't working label Dec 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug 🪲 Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant