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

Inconsistancies between packages in different documentation/example locations #306

Open
Kontrano opened this issue Apr 6, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Kontrano
Copy link
Contributor

Kontrano commented Apr 6, 2024

First of all thanks for the amazing package, I love this after having the hell of trying to implement flutter_quill.

As a new user I found a few inconsistencies in the install information, examples, and documentation which makes it harder for new users.

In the pub.dev install instructions it only lists to install fleathet but not parchment_delta. This is shown in the example file, however. Then if you go to the docks the example is still using quill_delta instead of parchment_delta. This led to some initial confusion for me and I assume also for others.

For the rest awesome package and love it so far. It is much easier to use than flutter_quill and the structure is also a lot more consistent with dart/flutters' usual approach to themes, widgets, and the like.

@amantoux amantoux added the documentation Improvements or additions to documentation label Apr 6, 2024
@Amir-P
Copy link
Member

Amir-P commented Apr 6, 2024

Thanks for the kind words.
We are aware of the problems our documentations have. Unfortunately, we have very limited resources, and resolving issues are at our top priority right now. Needless to say, we would be more than happy to see you or other users contributing! Documentations are at https://github.com/fleather-editor/fleather-editor.github.io. @Kontrano

@Kontrano
Copy link
Contributor Author

Kontrano commented Apr 7, 2024

Thanks for the link, ill add to it in the next week or so!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants