updated

Author: Nursid

docs/api/apiaccess/rag/add_file.md

@@ -33,4 +33,8 @@ async function exampleAddFile() {
     console.log("File added successfully.");
 }
 
-exampleAddFile();
+exampleAddFile();
+```
+
+### status 
+comming soon....

docs/api/apiaccess/rag/retrieve_related_knowledge.md

@@ -32,4 +32,8 @@ async function exampleRetrieveRelatedKnowledge() {
     console.log("Related knowledge retrieved.");
 }
 
-exampleRetrieveRelatedKnowledge();
+exampleRetrieveRelatedKnowledge();
+```
+
+### status 
+comming soon....

docs/api/apiaccess/taskplaner/addTask.md

@@ -6,13 +6,10 @@ cbparameters:
   parameters:
     - name: task
       typeName: string
-      description: The task to be added.
+      description: The task description to be added.
   returns:
     signatureTypeName: Promise
     description: A promise that resolves with the response from the add task event.
-    typeArgs:
-      - type: reference
-        name: AddTaskResponse
 data:
   name: addTask
   category: taskplaner
@@ -21,25 +18,22 @@ data:
 <CBBaseInfo/> 
 <CBParameters/>
 
-### Example
+## Example
 
-```js
-import codebolt from '@codebolt/codeboltjs';
+```javascript
+const addResult = await codebolt.taskplaner.addTask('Complete project documentation');
+console.log('✅ Task added successfully', addResult);
 
-async function exampleAddTask() {
-    try {
-        const response = await codebolt.taskplaner.addTask("Complete project documentation");
-        console.log("Task added successfully:", response);
-    } catch (error) {
-        console.error("Failed to add task:", error);
-    }
-}
-
-exampleAddTask();
-```
-
-### Explaination 
+// Adding multiple tasks
+const tasks = [
+    'Review code changes',
+    'Update unit tests', 
+    'Fix bug in authentication module',
+    'Prepare release notes'
+];
 
-The codebolt.taskplaner.addTask function takes a single parameter, task, which is a string representing the task you want to add. This function sends the task to the task planner system using a WebSocket message.
-
-task (string): The description of the task to be added.
+for (const task of tasks) {
+    await codebolt.taskplaner.addTask(task);
+}
+console.log('✅ Multiple tasks added successfully');
+```

docs/api/apiaccess/taskplaner/getTasks.md

@@ -7,39 +7,27 @@ cbparameters:
   returns:
     signatureTypeName: Promise
     description: A promise that resolves with the response from the get tasks event.
-    typeArgs:
-      - type: intrinsic
-        name: any
 data:
   name: getTasks
   category: taskplaner
   link: getTasks.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
-
-### Examples
-
-
-### Example
-
-```js
-import codebolt from '@codebolt/codeboltjs';
-
-async function exampleGetTasks() {
-    try {
-        const response =  await codebolt.taskplaner.getTasks()
-
-        console.log("Tasks retrieved successfully:", response);
-    } catch (error) {
-        console.error("Failed to retrieve tasks:", error);
-    }
+<CBParameters/>
+
+## Example
+
+```javascript
+const tasksResult = await codebolt.taskplaner.getTasks();
+console.log('✅ Tasks retrieved successfully');
+console.log('   - Tasks:', tasksResult);
+console.log('   - Total tasks:', tasksResult?.data?.length || 0);
+
+// Check if tasks exist
+if (tasksResult?.data && tasksResult.data.length > 0) {
+    console.log('   - Sample tasks:');
+    tasksResult.data.slice(0, 3).forEach((task, index) => {
+        console.log(`     ${index + 1}. ${task}`);
+    });
 }
-
-exampleGetTasks();
-
 ```
-
-### Explaination 
-
-The codebolt.taskplaner.getTasks function does not take any parameters. It retrieves the current list of tasks from the task planner.

docs/api/apiaccess/taskplaner/updateTask.md

@@ -10,9 +10,6 @@ cbparameters:
   returns:
     signatureTypeName: Promise
     description: A promise that resolves with the response from the update task event.
-    typeArgs:
-      - type: reference
-        name: UpdateTasksResponse
 data:
   name: updateTask
   category: taskplaner
@@ -21,20 +18,25 @@ data:
 <CBBaseInfo/> 
 <CBParameters/>
 
-### Example
 
-```js
+## Example
 
-import codebolt from '@codebolt/codeboltjs';
+```javascript
+const updateResult = await codebolt.taskplaner.updateTask('Complete project documentation - UPDATED with new requirements');
+console.log('✅ Task updated successfully');
+console.log('   - Response:', updateResult);
+console.log('   - Success:', updateResult?.success);
 
-async function exampleUpdateTask() {
-    try {
-        const response = await codebolt.taskplaner.updateTask("Update project documentation");
-        console.log("Task updated successfully:", response);
-    } catch (error) {
-        console.error("Failed to update task:", error);
-    }
-}
+// Update multiple tasks with status
+const taskUpdates = [
+    'Review code changes - COMPLETED',
+    'Update unit tests - IN PROGRESS',
+    'Fix bug in authentication module - ASSIGNED to John',
+    'Prepare release notes - PENDING review'
+];
 
-exampleUpdateTask();
+for (const update of taskUpdates) {
+    await codebolt.taskplaner.updateTask(update);
+}
+console.log('✅ Multiple task updates completed');
 ```

docs/api/apiaccess/terminal/executeCommand.md

@@ -1,8 +1,7 @@
 ---
 name: executeCommand
 cbbaseinfo:
-  description: >-
-    Executes a given command and returns the result.
+  description: Executes a given command and returns the result.
 
     Listens for messages from the WebSocket that indicate the output, error, or
     finish state
@@ -13,35 +12,40 @@ cbparameters:
     - name: command
       typeName: string
       description: The command to be executed.
+    - name: returnEmptyStringOnSuccess
+      typeName: boolean
+      description: Optional parameter to return empty string on success. Defaults to false.
   returns:
     signatureTypeName: Promise
-    description: >-
-      A promise that resolves with the command's output, error, or finish
-      signal.
-    typeArgs:
-      - type: ' '
-        name: ' '
+    description: A promise that resolves with the command's output or error.
+    typeArgs: []
 data:
   name: executeCommand
   category: terminal
   link: executeCommand.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
-
-### Examples
- 
-```js 
-
-// The codebolt.terminal.executeCommand function is likely used to execute a command in the terminal and retrieve the result.
-
-const cmd = await codebolt.terminal.executeCommand("npm i nodemon");
-
-```
-
-
-### Explaination 
-
-The codebolt.terminal.executeCommand function takes a single parameter, which is the command you want to execute in the terminal. It returns the result of the command execution. It has one parameter.
-
-command (string): The command to be executed in the terminal. In this case, the command is "npm i nodemon", which installs the nodemon package using npm.
+<CBParameters/>
+
+## Example
+
+```javascript
+// Basic command execution
+const nodeVersionResult = await codebolt.terminal.executeCommand('node --version');
+console.log('✅ Node version:', nodeVersionResult);
+
+const npmVersionResult = await codebolt.terminal.executeCommand('npm --version');
+console.log('✅ NPM version:', npmVersionResult);
+
+// Command with return empty string on success
+const emptyResult = await codebolt.terminal.executeCommand('echo "test"', true);
+console.log('✅ Empty result (success):', emptyResult);
+
+// Error handling
+try {
+    const result = await codebolt.terminal.executeCommand('invalidcommand');
+    console.log('Command result:', result);
+} catch (error) {
+    console.error('Command failed:', error.message);
+}
+```

docs/api/apiaccess/terminal/executeCommandRunUntilError.md

@@ -1,8 +1,7 @@
 ---
 name: executeCommandRunUntilError
 cbbaseinfo:
-  description: >-
-    Executes a given command and keeps running until an error occurs.
+  description: Executes a given command and keeps running until an error occurs.
 
     Listens for messages from the WebSocket and resolves the promise when an
     error is encountered.
@@ -11,12 +10,13 @@ cbparameters:
     - name: command
       typeName: string
       description: The command to be executed.
+    - name: executeInMain
+      typeName: boolean
+      description: Optional parameter to execute in main terminal. Defaults to false.
   returns:
     signatureTypeName: Promise
     description: A promise that resolves when an error occurs during command execution.
-    typeArgs:
-      - type: reference
-        name: CommandError
+   
 data:
   name: executeCommandRunUntilError
   category: terminal
@@ -25,17 +25,22 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-
-### Example 
-
-```js 
-
-codebolt.terminal.executeCommandRunUntilError("npm i nodemon")
-
-```
-
-### Explaination 
-
-The codebolt.terminal.executeCommandRunUntilError function takes a single parameter, command, which is a string representing the command you want to execute in the terminal. The function runs the specified command repeatedly until an error occurs.
-
-command (string): The command to be executed in the terminal.
+## Example
+
+```javascript
+// Run command until error occurs
+try {
+    const errorResult = await codebolt.terminal.executeCommandRunUntilError('npm run dev');
+    console.log('Command stopped due to error:', errorResult);
+} catch (error) {
+    console.error('Command execution failed:', error.message);
+}
+
+// Run in main terminal
+try {
+    const result = await codebolt.terminal.executeCommandRunUntilError('npm start', true);
+    console.log('Main terminal error:', result);
+} catch (error) {
+    console.error('Main terminal execution failed:', error.message);
+}
+```