Improve preference description (#14376)

fixed #14375 Signed-off-by: Jonas Helming <[email protected]>
eclipse-theia · Oct 30, 2024 · c24504b · c24504b
1 parent 5b2836a
commit c24504b
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/packages/ai-llamafile/src/browser/llamafile-preferences.ts b/packages/ai-llamafile/src/browser/llamafile-preferences.ts
@@ -25,13 +25,15 @@ export const aiLlamafilePreferencesSchema: PreferenceSchema = {
     properties: {
         [PREFERENCE_LLAMAFILE]: {
             title: AI_LLAMAFILE_PREFERENCES_TITLE,
-            markdownDescription: '❗ This setting allows you to add llamafiles.\
+            markdownDescription: 'This setting allows you to configure and manage LlamaFile models in Theia IDE.\
             \n\
-            You need to provide a user friendly `name`, the file `uri` to the llamafile and the `port` to use.\
+            Each entry requires a user-friendly `name`, the file `uri` pointing to your LlamaFile, and the `port` on which it will run.\
             \n\
-            In order to start your llamafile you have to call the "Start Llamafile" command where you can then select the llamafile to start.\
+            To start a LlamaFile, use the "Start LlamaFile" command, which enables you to select the desired model.\
             \n\
-            If you modify an entry, e.g. change the port and the server was already running, then it will be stopped and you have to manually start it again.',
+            If you edit an entry (e.g., change the port), any running instance will stop, and you will need to manually start it again.\
+            \n\
+            [Learn more about configuring and managing LlamaFiles in the Theia IDE documentation](https://theia-ide.org/docs/user_ai/#llamafile-models).',
             type: 'array',
             default: [],
             items: {

diff --git a/packages/ai-openai/src/browser/openai-preferences.ts b/packages/ai-openai/src/browser/openai-preferences.ts
@@ -48,7 +48,9 @@ export const OpenAiPreferencesSchema: PreferenceSchema = {
             \n\
             - specify a unique `id` to identify the custom model in the UI. If none is given `model` will be used as `id`.\
             \n\
-            - provide an `apiKey` to access the API served at the given url. Use `true` to indicate the use of the global OpenAI API key.',
+            - provide an `apiKey` to access the API served at the given url. Use `true` to indicate the use of the global OpenAI API key.\
+            \n\
+            Refer to [our documentation](https://theia-ide.org/docs/user_ai/#openai-compatible-models-eg-via-vllm) for more information.',
             default: [],
             items: {
                 type: 'object',