better doc

Author: QuentinGab

README.md

@@ -38,13 +38,35 @@ Here’s the content of the published config file:
 ```php
 return [
 
+    /*
+    |--------------------------------------------------------------------------
+    | Language Paths
+    |--------------------------------------------------------------------------
+    |
+    | This is the path where your translation files are stored. In a standard Laravel installation, you should not need to change it.
+    |
+    */
     'lang_path' => lang_path(),
 
-    /**
-     * Automatically sort translation keys after each manipulation (translate, grammar check, etc.).
-     */
+    /*
+    |--------------------------------------------------------------------------
+    | Auto Sort Keys
+    |--------------------------------------------------------------------------
+    |
+    | If set to true, all keys will be sorted automatically after any file manipulation such as 'edit', 'translate', or 'proofread'.
+    |
+    */
     'sort_keys' => false,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Third-Party Services
+    |--------------------------------------------------------------------------
+    |
+    | Define the API keys for your third-party services. These keys are reused for both 'translate' and 'proofread'.
+    | You can override this configuration and define specific service options, for example, in 'translate.services.openai.key'.
+    |
+    */
     'services' => [
         'openai' => [
             'key' => env('OPENAI_API_KEY'),
@@ -56,17 +78,48 @@ return [
         ],
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Translation Service
+    |--------------------------------------------------------------------------
+    |
+    | These are the services that can be used to translate your strings from one locale to another.
+    | You can customize their behavior here, or you can define your own service.
+    |
+    */
     'translate' => [
+        /**
+         * Supported: 'openai', 'deepl', 'MyOwnServiceClass::name'
+         * Define your own service using the class's name: 'MyOwnServiceClass::class'
+         */
         'service' => null,
         'services' => [
             'openai' => [
                 'model' => 'gpt-4o',
-                'prompt' => "Translate the following JSON to the locale '{targetLocale}' while preserving the keys.",
+                'prompt' => "
+                            As an experienced copywriter and translator specializing in website copy, your task is to translate the provided content from a specific website.
+                            Your translations should maintain the original tone while being adapted to the target language, ensuring they are both relevant and clear.
+                            The content will be provided in JSON format, and you must translate it to the locale '{targetLocale}'.
+                            Ensure that all JSON keys remain preserved and unchanged.
+                            ",
             ],
         ],
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Proofreading Service
+    |--------------------------------------------------------------------------
+    |
+    | These are the services that can be used to proofread your strings.
+    | You can customize their behavior here, or you can define your own service.
+    |
+    */
     'proofread' => [
+        /**
+         * Supported: 'openai', 'MyOwnServiceClass::name'
+         * Define your own service using the class's name: 'MyOwnServiceClass::class'
+         */
         'service' => null,
         'services' => [
             'openai' => [
@@ -82,7 +135,19 @@ return [
         ],
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Search Code / Dead Code Service
+    |--------------------------------------------------------------------------
+    |
+    | These are the services that can be used to detect dead translation strings in your codebase.
+    | You can customize their behavior here, or you can define your own service.
+    |
+    */
     'searchcode' => [
+        /**
+         * Supported: 'php-parser', 'MyOwnServiceClass::name'
+         */
         'service' => 'php-parser',
 
         /**
@@ -100,21 +165,27 @@ return [
 
         /**
          * Translation keys to exclude from dead code detection.
+         * By default, the default Laravel translations are excluded.
          */
         'ignored_translations' => [
             'auth',
             'pagination',
             'passwords',
-            'validation'
+            'validation',
         ],
 
         'services' => [
             'php-parser' => [
+                /**
+                 * To speed up detection, all the results of the scan will be stored in a file.
+                 * Feel free to change the path if needed.
+                 */
                 'cache_path' => base_path('.translator.cache'),
             ],
         ],
 
     ],
+
 ];
 ```