fleather-editor / fleather

Soft and gentle rich text editing for Flutter applications.
https://fleather-editor.github.io
Other
205 stars 36 forks source link

Inconsistancies between packages in different documentation/example locations #306

Open Kontrano opened 7 months ago

Kontrano commented 7 months ago

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.

Amir-P commented 7 months ago

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 commented 7 months ago

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