Skip to content

Commit 2f26437

Browse files
committed
Updated Docs
1 parent e9026f1 commit 2f26437

20 files changed

+44757
-43584
lines changed

docs/api/cbstate/addToAgentState.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: addToAgentState
3+
cbbaseinfo:
4+
description: ' '
5+
cbparameters:
6+
parameters:
7+
- name: key
8+
typeName: string
9+
description: ''
10+
- name: value
11+
typeName: string
12+
description: ''
13+
returns:
14+
signatureTypeName: Promise
15+
description: ' '
16+
---
17+
<CBBaseInfo/>
18+
<CBParameters/>

docs/api/cbstate/cb_index.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
---
22
cbapicategory:
3+
- name: addToAgentState
4+
link: addToAgentState
5+
description: ' '
6+
- name: getAgentState
7+
link: getAgentState
8+
description: ' '
39
- name: getApplicationState
410
link: getApplicationState
511
description: ' '

docs/api/cbstate/getAgentState.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: getAgentState
3+
cbbaseinfo:
4+
description: ' '
5+
cbparameters:
6+
parameters: []
7+
returns:
8+
signatureTypeName: Promise
9+
description: ' '
10+
---
11+
<CBBaseInfo/>
12+
<CBParameters/>

docs/api/codeutils/cb_index.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,19 @@ cbapicategory:
55
description: ' '
66
- name: getCodeTree
77
link: getCodeTree
8-
description: Asynchronously generates a code tree from the provided source code.
8+
description: ' '
9+
- name: getJsTree
10+
link: getJsTree
11+
description: ' '
12+
- name: getMatcherList
13+
link: getMatcherList
14+
description: ' '
15+
- name: matchDetail
16+
link: matchDetail
17+
description: ' '
18+
- name: performMatch
19+
link: performMatch
20+
description: ' '
921

1022
---
1123
# codeutils

docs/api/codeutils/getCodeTree.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
name: getCodeTree
33
cbbaseinfo:
4-
description: Asynchronously generates a code tree from the provided source code.
4+
description: ' '
55
cbparameters:
66
parameters: []
77
returns:
88
signatureTypeName: Promise
9-
description: A promise that resolves with the code tree.
9+
description: ' '
1010
---
1111
<CBBaseInfo/>
1212
<CBParameters/>

docs/api/codeutils/getJsTree.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: getJsTree
3+
cbbaseinfo:
4+
description: ' '
5+
cbparameters:
6+
parameters:
7+
- name: filePath
8+
typeName: string
9+
description: ''
10+
returns:
11+
signatureTypeName: Promise
12+
description: ' '
13+
---
14+
<CBBaseInfo/>
15+
<CBParameters/>

docs/api/codeutils/getMatcherList.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: getMatcherList
3+
cbbaseinfo:
4+
description: ' '
5+
cbparameters:
6+
parameters: []
7+
returns:
8+
signatureTypeName: Promise
9+
description: ' '
10+
---
11+
<CBBaseInfo/>
12+
<CBParameters/>

docs/api/codeutils/matchDetail.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: matchDetail
3+
cbbaseinfo:
4+
description: ' '
5+
cbparameters:
6+
parameters:
7+
- name: matcher
8+
typeName: string
9+
description: ''
10+
returns:
11+
signatureTypeName: Promise
12+
description: ' '
13+
---
14+
<CBBaseInfo/>
15+
<CBParameters/>

docs/api/codeutils/performMatch.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: performMatch
3+
cbbaseinfo:
4+
description: ' '
5+
cbparameters:
6+
parameters:
7+
- name: matcherDefinition
8+
typeName: object
9+
description: ''
10+
- name: problemPatterns
11+
description: ''
12+
- name: problems
13+
description: ''
14+
returns:
15+
signatureTypeName: Promise
16+
description: ' '
17+
---
18+
<CBBaseInfo/>
19+
<CBParameters/>

docs/api/llm/cb_index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
cbapicategory:
33
- name: inference
44
link: inference
5-
description: "Sends an inference request to the LLM and returns the model's response.\r\nThe model is selected based on the provided "
5+
description: |-
6+
Sends an inference request to the LLM and returns the model's response.
7+
The model is selected based on the provided
68
79
---
810
# llm

docs/api/llm/inference.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
name: inference
33
cbbaseinfo:
4-
description: "Sends an inference request to the LLM and returns the model's response.\r\nThe model is selected based on the provided "
4+
description: |-
5+
Sends an inference request to the LLM and returns the model's response.
6+
The model is selected based on the provided
57
cbparameters:
68
parameters:
79
- name: message

docs/api/outputparsers/cb_index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
cbapicategory:
33
- name: init
44
link: init
5-
description: "Initializes the output parser module.\r\nCurrently, this function does not perform any operations."
5+
description: |-
6+
Initializes the output parser module.
7+
Currently, this function does not perform any operations.
68
- name: parseErrors
79
link: parseErrors
810
description: Parses the given output and returns all the error messages.

docs/api/outputparsers/init.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
name: init
33
cbbaseinfo:
4-
description: "Initializes the output parser module.\r\nCurrently, this function does not perform any operations."
4+
description: |-
5+
Initializes the output parser module.
6+
Currently, this function does not perform any operations.
57
cbparameters:
68
parameters:
79
- name: output

docs/api/project/cb_index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ cbapicategory:
55
description: Retrieves the path of the current project.
66
- name: getProjectSettings
77
link: getProjectSettings
8-
description: "Placeholder for a method to get project settings.\r\nCurrently, this method does not perform any operations."
8+
description: |-
9+
Placeholder for a method to get project settings.
10+
Currently, this method does not perform any operations.
911
1012
---
1113
# project

docs/api/project/getProjectSettings.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
name: getProjectSettings
33
cbbaseinfo:
4-
description: "Placeholder for a method to get project settings.\r\nCurrently, this method does not perform any operations."
4+
description: |-
5+
Placeholder for a method to get project settings.
6+
Currently, this method does not perform any operations.
57
cbparameters:
68
parameters:
79
- name: output

docs/api/terminal/cb_index.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,20 @@ cbapicategory:
55
description: ' '
66
- name: executeCommand
77
link: executeCommand
8-
description: "Executes a given command and returns the result.\r\nListens for messages from the WebSocket that indicate the output, error, or finish state\r\nof the executed command and resolves the promise accordingly."
8+
description: >-
9+
Executes a given command and returns the result.
10+
11+
Listens for messages from the WebSocket that indicate the output, error,
12+
or finish state
13+
14+
of the executed command and resolves the promise accordingly.
915
- name: executeCommandRunUntilError
1016
link: executeCommandRunUntilError
11-
description: "Executes a given command and keeps running until an error occurs.\r\nListens for messages from the WebSocket and resolves the promise when an error is encountered."
17+
description: >-
18+
Executes a given command and keeps running until an error occurs.
19+
20+
Listens for messages from the WebSocket and resolves the promise when an
21+
error is encountered.
1222
- name: executeCommandWithStream
1323
link: executeCommandWithStream
1424
description: ' '

docs/api/terminal/executeCommand.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
---
22
name: executeCommand
33
cbbaseinfo:
4-
description: "Executes a given command and returns the result.\r\nListens for messages from the WebSocket that indicate the output, error, or finish state\r\nof the executed command and resolves the promise accordingly."
4+
description: >-
5+
Executes a given command and returns the result.
6+
7+
Listens for messages from the WebSocket that indicate the output, error, or
8+
finish state
9+
10+
of the executed command and resolves the promise accordingly.
511
cbparameters:
612
parameters:
713
- name: command

docs/api/terminal/executeCommandRunUntilError.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
---
22
name: executeCommandRunUntilError
33
cbbaseinfo:
4-
description: "Executes a given command and keeps running until an error occurs.\r\nListens for messages from the WebSocket and resolves the promise when an error is encountered."
4+
description: >-
5+
Executes a given command and keeps running until an error occurs.
6+
7+
Listens for messages from the WebSocket and resolves the promise when an
8+
error is encountered.
59
cbparameters:
610
parameters:
711
- name: command

0 commit comments

Comments
 (0)