Skip to content

Commit 280529a

Browse files
committed
updated Docs
1 parent 53c79df commit 280529a

28 files changed

+92
-95
lines changed

docs/api/browser/cb_index.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,52 @@
11
---
22
cbapicategory:
33
- name: click
4-
link: click.md
4+
link: click
55
description: Clicks on a specified element on the page.
66
- name: close
7-
link: close.md
7+
link: close
88
description: Closes the current page.
99
- name: enter
10-
link: enter.md
10+
link: enter
1111
description: Simulates the Enter key press on the current page.
1212
- name: extractText
13-
link: extractText.md
13+
link: extractText
1414
description: Extracts text from the current page.
1515
- name: getContent
16-
link: getContent.md
16+
link: getContent
1717
description: Retrieves the content of the current page.
1818
- name: getHTML
19-
link: getHTML.md
19+
link: getHTML
2020
description: Retrieves the HTML content of the current page.
2121
- name: getMarkdown
22-
link: getMarkdown.md
22+
link: getMarkdown
2323
description: Retrieves the Markdown content of the current page.
2424
- name: getPDF
25-
link: getPDF.md
25+
link: getPDF
2626
description: Retrieves the PDF content of the current page.
2727
- name: getUrl
28-
link: getUrl.md
28+
link: getUrl
2929
description: Retrieves the current URL of the browser's active page.
3030
- name: goToPage
31-
link: goToPage.md
31+
link: goToPage
3232
description: Navigates to a specified URL.
3333
- name: newPage
34-
link: newPage.md
34+
link: newPage
3535
description: Opens a new page in the browser.
3636
- name: pdfToText
37-
link: pdfToText.md
37+
link: pdfToText
3838
description: Converts the PDF content of the current page to text.
3939
- name: screenshot
40-
link: screenshot.md
40+
link: screenshot
4141
description: Takes a screenshot of the current page.
4242
- name: scroll
43-
link: scroll.md
43+
link: scroll
4444
description: Scrolls the current page in a specified direction by a specified number of pixels.
4545
- name: search
46-
link: search.md
46+
link: search
4747
description: Performs a search on the current page using a specified query.
4848
- name: type
49-
link: type.md
49+
link: type
5050
description: Types text into a specified element on the page.
5151
---
5252
# browser

docs/api/cbstate/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "cbstate",
2+
"label": "Cbstate",
33
"position": 2.5,
44
"collapsible": true,
55
"collapsed": true,

docs/api/cbstate/cb_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
cbapicategory:
33
- name: getApplicationState
4-
link: getApplicationState.md
4+
link: getApplicationState
55
description:
66
---
77
# cbstate

docs/api/chat/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "chat",
2+
"label": "Chat",
33
"position": 2.5,
44
"collapsible": true,
55
"collapsed": true,

docs/api/chat/cb_index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
cbapicategory:
33
- name: eventEmitter
4-
link: eventEmitter.md
4+
link: eventEmitter
55
description:
66
- name: stopProcess
7-
link: stopProcess.md
7+
link: stopProcess
88
description:
99
- name: getChatHistory
10-
link: getChatHistory.md
10+
link: getChatHistory
1111
description:
1212
- name: processStarted
13-
link: processStarted.md
13+
link: processStarted
1414
description:
1515
- name: sendMessage
16-
link: sendMessage.md
16+
link: sendMessage
1717
description:
1818
- name: waitforReply
19-
link: waitforReply.md
19+
link: waitforReply
2020
description:
2121
---
2222
# chat

docs/api/codeparsers/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "codeparsers",
2+
"label": "Codeparsers",
33
"position": 2.5,
44
"collapsible": true,
55
"collapsed": true,

docs/api/codeparsers/cb_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
cbapicategory:
33
- name: getAstTreeInFile
4-
link: getAstTreeInFile.md
4+
link: getAstTreeInFile
55
description: Generates an Abstract Syntax Tree (AST) for a given file.
66
- name: getClassesInFile
7-
link: getClassesInFile.md
7+
link: getClassesInFile
88
description: Retrieves the classes in a given file.
99
- name: getFunctionsinClass
10-
link: getFunctionsinClass.md
10+
link: getFunctionsinClass
1111
description: Retrieves the functions in a given class within a file.
1212
---
1313
# codeparsers

docs/api/codeutils/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "codeutils",
2+
"label": "Codeutils",
33
"position": 2.5,
44
"collapsible": true,
55
"collapsed": true,

docs/api/codeutils/cb_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
cbapicategory:
33
- name: getAllFilesAsMarkDown
4-
link: getAllFilesAsMarkDown.md
4+
link: getAllFilesAsMarkDown
55
description:
66
- name: getCodeTree
7-
link: getCodeTree.md
7+
link: getCodeTree
88
description: Asynchronously generates a code tree from the provided source code.
99
---
1010
# codeutils

docs/api/crawler/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "crawler",
2+
"label": "Crawler",
33
"position": 2.5,
44
"collapsible": true,
55
"collapsed": true,

docs/api/crawler/cb_index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
---
22
cbapicategory:
33
- name: click
4-
link: click.md
4+
link: click
55
description: Simulates a click event on an element with the specified ID.
66
- name: crawl
7-
link: crawl.md
7+
link: crawl
88
description: Initiates a crawl process.
99
- name: enter
10-
link: enter.md
10+
link: enter
1111
description: Simulates the Enter key press using the crawler.
1212
- name: goToPage
13-
link: goToPage.md
13+
link: goToPage
1414
description: Directs the crawler to navigate to a specified URL.
1515
- name: screenshot
16-
link: screenshot.md
16+
link: screenshot
1717
description: Takes a screenshot using the crawler.
1818
- name: scroll
19-
link: scroll.md
19+
link: scroll
2020
description: Scrolls the crawler in a specified direction.
2121
- name: start
22-
link: start.md
22+
link: start
2323
description: Starts the crawler.
2424
- name: type
25-
link: type.md
25+
link: type
2626
description: Types the provided text into an element with the specified ID.
2727
---
2828
# crawler

docs/api/dbmemory/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"label": "dbmemory",
2+
"label": "DBmemory",
33
"position": 2.5,
44
"collapsible": true,
55
"collapsed": true,

docs/api/dbmemory/cb_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
cbapicategory:
33
- name: addKnowledge
4-
link: addKnowledge.md
4+
link: addKnowledge
55
description: Adds a key-value pair to the in-memory database.
66
- name: getKnowledge
7-
link: getKnowledge.md
7+
link: getKnowledge
88
description: Retrieves a value from the in-memory database by key.
99
---
1010
# dbmemory

docs/api/debug/cb_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
cbapicategory:
33
- name: debug
4-
link: debug.md
4+
link: debug
55
description:
66
- name: openDebugBrowser
7-
link: openDebugBrowser.md
7+
link: openDebugBrowser
88
description:
99
---
1010
# debug

docs/api/docutils/cb_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
cbapicategory:
33
- name: pdf_to_text
4-
link: pdf_to_text.md
4+
link: pdf_to_text
55
description: Converts a PDF document to text.
66
---
77
# docutils

docs/api/fs/cb_index.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
22
cbapicategory:
33
- name: createFile
4-
link: createFile.md
4+
link: createFile
55
description:
66
- name: createFolder
7-
link: createFolder.md
7+
link: createFolder
88
description:
99
- name: deleteFile
10-
link: deleteFile.md
10+
link: deleteFile
1111
description:
1212
- name: deleteFolder
13-
link: deleteFolder.md
13+
link: deleteFolder
1414
description:
1515
- name: listFile
16-
link: listFile.md
16+
link: listFile
1717
description:
1818
- name: readFile
19-
link: readFile.md
19+
link: readFile
2020
description:
2121
- name: updateFile
22-
link: updateFile.md
22+
link: updateFile
2323
description:
2424
---
2525
# fs

docs/api/git/cb_index.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
11
---
22
cbapicategory:
33
- name: add
4-
link: add.md
4+
link: add
55
description: Adds changes in the local repository to the staging area at the given path.
66
- name: branch
7-
link: branch.md
7+
link: branch
88
description: Creates a new branch in the local repository at the given path.
99
- name: checkout
10-
link: checkout.md
10+
link: checkout
1111
description: Checks out a branch or commit in the local repository at the given path.
1212
- name: clone
13-
link: clone.md
13+
link: clone
1414
description: Clones a Git repository from the given URL to the specified path.
1515
- name: commit
16-
link: commit.md
16+
link: commit
1717
description: Commits the staged changes in the local repository with the given commit message.
1818
- name: diff
19-
link: diff.md
19+
link: diff
2020
description: Retrieves the diff of changes for a specific commit in the local repository.
2121
- name: init
22-
link: init.md
22+
link: init
2323
description: Initializes a new Git repository at the given path.
2424
- name: logs
25-
link: logs.md
25+
link: logs
2626
description: Retrieves the commit logs for the local repository at the given path.
2727
- name: pull
28-
link: pull.md
28+
link: pull
2929
description: Pulls the latest changes from the remote repository to the local repository at the given path.
3030
- name: push
31-
link: push.md
31+
link: push
3232
description: Pushes local repository changes to the remote repository at the given path.
3333
- name: status
34-
link: status.md
34+
link: status
3535
description: Retrieves the status of the local repository at the given path.
3636
---
3737
# git

docs/api/llm/cb_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
cbapicategory:
33
- name: inference
4-
link: inference.md
4+
link: inference
55
description: Sends an inference request to the LLM and returns the model's response.
66
The model is selected based on the provided
77
---

docs/api/outputparsers/cb_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
cbapicategory:
33
- name: init
4-
link: init.md
4+
link: init
55
description: Initializes the output parser module.
66
Currently, this function does not perform any operations.
77
- name: parseErrors
8-
link: parseErrors.md
8+
link: parseErrors
99
description: Parses the given output and returns all the error messages.
1010
- name: parseWarnings
11-
link: parseWarnings.md
11+
link: parseWarnings
1212
description: Parses the given output and returns all the warning messages.
1313
---
1414
# outputparsers

docs/api/project/cb_index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
cbapicategory:
33
- name: getProjectPath
4-
link: getProjectPath.md
4+
link: getProjectPath
55
description: Retrieves the path of the current project.
66
- name: getProjectSettings
7-
link: getProjectSettings.md
7+
link: getProjectSettings
88
description: Placeholder for a method to get project settings.
99
Currently, this method does not perform any operations.
1010
---

docs/api/rag/cb_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
cbapicategory:
33
- name: add_file
4-
link: add_file.md
4+
link: add_file
55
description: Adds a file to the CodeBolt File System.
66
- name: init
7-
link: init.md
7+
link: init
88
description: Initializes the CodeBolt File System Module.
99
- name: retrieve_related_knowledge
10-
link: retrieve_related_knowledge.md
10+
link: retrieve_related_knowledge
1111
description: Retrieves related knowledge for a given query and filename.
1212
---
1313
# rag

0 commit comments

Comments
 (0)