From abb3057e559c78bc2eeaa545a5a95d17b0081f1a Mon Sep 17 00:00:00 2001
From: Ellet <hello@freshplatform.net>
Date: Sun, 12 Nov 2023 06:08:04 +0300
Subject: [PATCH] Add development notes

---
 README.md                | 31 +++++++++++++++++++++++++++++--
 doc/CONTRIBUTING.md      |  2 +-
 doc/development_notes.md |  3 +++
 3 files changed, 33 insertions(+), 3 deletions(-)
 create mode 100644 doc/development_notes.md

diff --git a/README.md b/README.md
index ae001b81..fedc5662 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,7 @@ Pub: [FlutterQuill]
   - [Input / Output](#input--output)
   - [Configurations](#configurations)
     - [Using Custom App Widget](#using-custom-app-widget)
+    - [Localizations setup](#localizations-setup)
     - [Font Size](#font-size)
     - [Font Family](#font-family)
     - [Custom Buttons](#custom-buttons)
@@ -176,10 +177,34 @@ localizationsDelegates: const [
 ],
 ```
 
-in addition to the required delegates by this library
-
 Note: In the latest versions of `FluentApp` you no longer need to add the `localizationsDelegates` but this is just an example, for more [info](https://github.com/bdlukaa/fluent_ui/pull/946)
 
+There are additonal notes in [Localizations](#localizations) section
+
+### Localizations setup
+in addition to the required delegatess which mentioned above in [Using custom app widget](#using-custom-app-widget)
+
+which are:
+```dart
+localizationsDelegates: const [
+    DefaultCupertinoLocalizations.delegate,
+    DefaultMaterialLocalizations.delegate,
+    DefaultWidgetsLocalizations.delegate,
+],
+```
+which are used by offical flutter widgets
+
+The library also needs the 
+```dart
+// Required localizations delegates ...
+FlutterQuillLocalizations.delegate
+```
+
+To offer the default localizations.
+
+But **you don't have to** since we have wraped the `QuillEditor` and `QuillToolbar` with `FlutterQuillLocalizationsWidget` which will check if it sets then it will go, if not, then it will be provided only for them, so it's not really required, but if you are overriding the `localizationsDelegates` you could also add the `FlutterQuillLocalizations.delegate`
+which won't hurt
+
 ### Font Size
 
 Within the editor toolbar, a drop-down with font-sizing capabilities is available. This can be enabled or disabled with `showFontSize`.
@@ -302,6 +327,8 @@ We welcome contributions!
 
 Please follow these guidelines when contributing to the project. See [CONTRIBUTING.md](./doc/CONTRIBUTING.md) for more details. <br>
 
+We must mention that the `CONTRIBUTING.md` have a development notes, so if you planning on contribtuing to the repo, please read it.
+
 You can check the [Todo](./doc/todo.md) list if you want to
 
 [Quill]: https://quilljs.com/docs/formats
diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md
index f19febf3..8f2d1740 100644
--- a/doc/CONTRIBUTING.md
+++ b/doc/CONTRIBUTING.md
@@ -61,4 +61,4 @@ git push origin your-branch-name
 Thank you for your time and efforts in this open-source community project!!
 
 ## Development Notes
-- When update the translations or localizations in the app, please take a look at the [translation](./translation.md) page as it have important notes in order to work
\ No newline at end of file
+Please read the [Development Notes](./development_notes.md) as they are important while development
\ No newline at end of file
diff --git a/doc/development_notes.md b/doc/development_notes.md
new file mode 100644
index 00000000..0a5f999d
--- /dev/null
+++ b/doc/development_notes.md
@@ -0,0 +1,3 @@
+# Development notes
+
+- When update the translations or localizations in the app, please take a look at the [translation](./translation.md) page as it have important notes in order to work
\ No newline at end of file