Merge branch 'main' of https://github.com/codeboltai/codeboltai.github.io

faisal004 · faisal004 · commit e505999a8222 · 2024-05-17T10:52:54.000+05:30
diff --git a/docs/api/cbstate/addToAgentState.md b/docs/api/cbstate/addToAgentState.md
@@ -1,21 +1,21 @@
 ---
 name: addToAgentState
 cbbaseinfo:
-  description: ' '
+  description: Adds a key-value pair to the agent's state on the server via WebSocket.
 cbparameters:
   parameters:
     - name: key
       typeName: string
-      description: ''
+      description: The key to add to the agent's state.
     - name: value
       typeName: string
-      description: ''
+      description: The value associated with the key.
   returns:
     signatureTypeName: Promise
-    description: ' '
+    description: A promise that resolves with the response to the addition request.
     typeArgs:
-      - type: intrinsic
-        name: void
+      - type: reference
+        name: AddToAgentStateResponse
 data:
   name: addToAgentState
   category: cbstate
diff --git a/docs/api/cbstate/cb_index.md b/docs/api/cbstate/cb_index.md
@@ -2,13 +2,13 @@
 cbapicategory:
   - name: addToAgentState
     link: addToAgentState
-    description: ' '
+    description: Adds a key-value pair to the agent's state on the server via WebSocket.
   - name: getAgentState
     link: getAgentState
-    description: ' '
+    description: Retrieves the current state of the agent from the server via WebSocket.
   - name: getApplicationState
     link: getApplicationState
-    description: ' '
+    description: Retrieves the current application state from the server via WebSocket.
 
 ---
 # cbstate
diff --git a/docs/api/cbstate/getAgentState.md b/docs/api/cbstate/getAgentState.md
@@ -1,15 +1,15 @@
 ---
 name: getAgentState
 cbbaseinfo:
-  description: ' '
+  description: Retrieves the current state of the agent from the server via WebSocket.
 cbparameters:
   parameters: []
   returns:
     signatureTypeName: Promise
-    description: ' '
+    description: A promise that resolves with the agent's state.
     typeArgs:
-      - type: intrinsic
-        name: any
+      - type: reference
+        name: GetAgentStateResponse
 data:
   name: getAgentState
   category: cbstate
diff --git a/docs/api/cbstate/getApplicationState.md b/docs/api/cbstate/getApplicationState.md
@@ -1,15 +1,15 @@
 ---
 name: getApplicationState
 cbbaseinfo:
-  description: ' '
+  description: Retrieves the current application state from the server via WebSocket.
 cbparameters:
   parameters: []
   returns:
     signatureTypeName: Promise
-    description: ' '
+    description: A promise that resolves with the application state.
     typeArgs:
-      - type: intrinsic
-        name: any
+      - type: reference
+        name: ApplicationState
 data:
   name: getApplicationState
   category: cbstate
diff --git a/docs/api/chat/cb_index.md b/docs/api/chat/cb_index.md
@@ -6,21 +6,27 @@ cbapicategory:
   - name: getChatHistory
     link: getChatHistory
     description: Retrieves the chat history from the server.
+  - name: processStarted
+    link: processStarted
+    description: >-
+      Notifies the server that a process has started and sets up an event
+      listener for stopProcessClicked events.
   - name: sendMessage
     link: sendMessage
     description: Sends a message through the WebSocket connection.
   - name: stopProcess
     link: stopProcess
-    description: ' '
+    description: |-
+      Stops the ongoing process.
+      Sends a specific message to the server to stop the process.
   - name: userMessageListener
     link: userMessageListener
-    description: ' '
+    description: >-
+      Sets up a listener for incoming WebSocket messages and emits a custom
+      event when a message is received.
   - name: waitforReply
     link: waitforReply
     description: Waits for a reply to a sent message.
-  - name: processStarted
-    link: processStarted
-    description: ' '
 
 ---
 # chat
diff --git a/docs/api/chat/eventEmitter.md b/docs/api/chat/eventEmitter.md
@@ -1,5 +1,8 @@
 ---
-name: eventEmitter
+data:
+  name: eventEmitter
+  category: chat
+  link: eventEmitter.md
 cbbaseinfo:
   description: ' '
 cbparameters:
@@ -8,10 +11,6 @@ cbparameters:
     signatureTypeName: ' '
     description: ' '
     typeArgs: []
-data:
-  name: eventEmitter
-  category: chat
-  link: eventEmitter.md
 ---
 <CBBaseInfo/> 
  <CBParameters/>
diff --git a/docs/api/chat/processStarted.md b/docs/api/chat/processStarted.md
@@ -1,17 +1,17 @@
 ---
-name: processStarted
+data:
+  name: processStarted
+  category: chat
+  link: processStarted.md
 cbbaseinfo:
-  description: ' '
+  description: >-
+    Notifies the server that a process has started and sets up an event listener
+    for stopProcessClicked events.
 cbparameters:
   parameters: []
   returns:
-    signatureTypeName: ' '
-    description: ' '
+    description: An object containing the event emitter and a stopProcess method.
     typeArgs: []
-data:
-  name: processStarted
-  category: chat
-  link: processStarted.md
 ---
 <CBBaseInfo/> 
  <CBParameters/>
diff --git a/docs/api/chat/stopProcess.md b/docs/api/chat/stopProcess.md
@@ -1,7 +1,9 @@
 ---
 name: stopProcess
 cbbaseinfo:
-  description: ' '
+  description: |-
+    Stops the ongoing process.
+    Sends a specific message to the server to stop the process.
 cbparameters:
   parameters: []
   returns:
diff --git a/docs/api/chat/userMessageListener.md b/docs/api/chat/userMessageListener.md
@@ -1,11 +1,13 @@
 ---
 name: userMessageListener
 cbbaseinfo:
-  description: ' '
+  description: >-
+    Sets up a listener for incoming WebSocket messages and emits a custom event
+    when a message is received.
 cbparameters:
   parameters: []
   returns:
-    description: ' '
+    description: The event emitter used for emitting custom events.
     typeArgs: []
 data:
   name: userMessageListener
diff --git a/docs/api/codeutils/getCodeTree.md b/docs/api/codeutils/getCodeTree.md
diff --git a/docs/api/debug/cb_index.md b/docs/api/debug/cb_index.md
@@ -2,10 +2,10 @@
 cbapicategory:
   - name: debug
     link: debug
-    description: ' '
+    description: Sends a log message to the debug websocket and waits for a response.
   - name: openDebugBrowser
     link: openDebugBrowser
-    description: ' '
+    description: Requests to open a debug browser at the specified URL and port.
 
 ---
 # debug
diff --git a/docs/api/debug/debug.md b/docs/api/debug/debug.md
@@ -1,13 +1,21 @@
 ---
 name: debug
 cbbaseinfo:
-  description: ' '
+  description: Sends a log message to the debug websocket and waits for a response.
 cbparameters:
-  parameters: []
+  parameters:
+    - name: log
+      typeName: string
+      description: The log message to send.
+    - name: type
+      typeName: logType
+      description: The type of the log message (info, error, warning).
   returns:
-    signatureTypeName: ' '
-    description: ' '
-    typeArgs: []
+    signatureTypeName: Promise
+    description: A promise that resolves with the response from the debug event.
+    typeArgs:
+      - type: reference
+        name: DebugAddLogResponse
 data:
   name: debug
   category: debug
diff --git a/docs/api/debug/openDebugBrowser.md b/docs/api/debug/openDebugBrowser.md
@@ -1,13 +1,23 @@
 ---
 name: openDebugBrowser
 cbbaseinfo:
-  description: ' '
+  description: Requests to open a debug browser at the specified URL and port.
 cbparameters:
-  parameters: []
+  parameters:
+    - name: url
+      typeName: string
+      description: The URL where the debug browser should be opened.
+    - name: port
+      typeName: number
+      description: The port on which the debug browser will listen.
   returns:
-    signatureTypeName: ' '
-    description: ' '
-    typeArgs: []
+    signatureTypeName: Promise
+    description: >-
+      A promise that resolves with the response from the open debug browser
+      event.
+    typeArgs:
+      - type: reference
+        name: OpenDebugBrowserResponse
 data:
   name: openDebugBrowser
   category: debug
diff --git a/docs/api/llm/inference.md b/docs/api/llm/inference.md
@@ -16,8 +16,8 @@ cbparameters:
     signatureTypeName: Promise
     description: A promise that resolves with the LLM's response.
     typeArgs:
-      - type: intrinsic
-        name: any
+      - type: reference
+        name: LLMResponse
 data:
   name: inference
   category: llm
diff --git a/docs/api/project/getProjectPath.md b/docs/api/project/getProjectPath.md
@@ -8,8 +8,8 @@ cbparameters:
     signatureTypeName: Promise
     description: A promise that resolves with the project path response.
     typeArgs:
-      - type: intrinsic
-        name: any
+      - type: reference
+        name: GetProjectPathResponse
 data:
   name: getProjectPath
   category: project
diff --git a/docs/api/terminal/executeCommand.md b/docs/api/terminal/executeCommand.md
@@ -19,8 +19,8 @@ cbparameters:
       A promise that resolves with the command's output, error, or finish
       signal.
     typeArgs:
-      - type: intrinsic
-        name: any
+      - type: ' '
+        name: ' '
 data:
   name: executeCommand
   category: terminal
diff --git a/docs/api/terminal/executeCommandRunUntilError.md b/docs/api/terminal/executeCommandRunUntilError.md
@@ -15,8 +15,8 @@ cbparameters:
     signatureTypeName: Promise
     description: A promise that resolves when an error occurs during command execution.
     typeArgs:
-      - type: intrinsic
-        name: any
+      - type: reference
+        name: CommandError
 data:
   name: executeCommandRunUntilError
   category: terminal
diff --git a/docs/api/tokenizer/addToken.md b/docs/api/tokenizer/addToken.md
@@ -1,18 +1,18 @@
 ---
 name: addToken
 cbbaseinfo:
-  description: Adds a token asynchronously.
+  description: Adds a token to the system via WebSocket.
 cbparameters:
   parameters:
     - name: key
       typeName: string
-      description: The key of the token to add.
+      description: The key associated with the token to be added.
   returns:
     signatureTypeName: Promise
-    description: A promise that resolves with the response.
+    description: A promise that resolves with the response from the add token event.
     typeArgs:
-      - type: intrinsic
-        name: any
+      - type: reference
+        name: AddTokenResponse
 data:
   name: addToken
   category: tokenizer
diff --git a/docs/api/tokenizer/cb_index.md b/docs/api/tokenizer/cb_index.md
@@ -2,10 +2,10 @@
 cbapicategory:
   - name: addToken
     link: addToken
-    description: Adds a token asynchronously.
+    description: Adds a token to the system via WebSocket.
   - name: getToken
     link: getToken
-    description: ' '
+    description: Retrieves a token from the system via WebSocket.
 
 ---
 # tokenizer
diff --git a/docs/api/tokenizer/getToken.md b/docs/api/tokenizer/getToken.md
@@ -1,18 +1,18 @@
 ---
 name: getToken
 cbbaseinfo:
-  description: ' '
+  description: Retrieves a token from the system via WebSocket.
 cbparameters:
   parameters:
     - name: key
       typeName: string
-      description: ''
+      description: The key associated with the token to be retrieved.
   returns:
     signatureTypeName: Promise
-    description: ' '
+    description: A promise that resolves with the response from the get token event.
     typeArgs:
-      - type: intrinsic
-        name: any
+      - type: reference
+        name: GetTokenResponse
 data:
   name: getToken
   category: tokenizer
diff --git a/docs/api/vectordb/addVectorItem.md b/docs/api/vectordb/addVectorItem.md
@@ -11,8 +11,8 @@ cbparameters:
     signatureTypeName: Promise
     description: A promise that resolves when the item is successfully added.
     typeArgs:
-      - type: intrinsic
-        name: any
+      - type: reference
+        name: AddVectorItemResponse
 data:
   name: addVectorItem
   category: vectordb
diff --git a/docs/api/vectordb/getVector.md b/docs/api/vectordb/getVector.md
diff --git a/docs/api/vectordb/queryVectorItem.md b/docs/api/vectordb/queryVectorItem.md
diff --git a/scripts/jsdoc_to_docusaurus.js b/scripts/jsdoc_to_docusaurus.js
diff --git a/src/components/CBParameters.jsx b/src/components/CBParameters.jsx
diff --git a/temp/newfile.json b/temp/newfile.json
diff --git a/temp/out.json b/temp/out.json
