Skip to content

Commit 53c79df

Browse files
utkarshxutkarshx
committed
updated the index file to yaml
1 parent 52f4b91 commit 53c79df

File tree

32 files changed

+422
-92
lines changed

32 files changed

+422
-92
lines changed

‎docs/api/browser/cb_index.md

+53-18
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,53 @@
1-
# Browser
2-
3-
- [click](click.md) - Clicks on a specified element on the page.
4-
- [close](close.md) - Closes the current page.
5-
- [enter](enter.md) - Simulates the Enter key press on the current page.
6-
- [extractText](extractText.md) - Extracts text from the current page.
7-
- [getContent](getContent.md) - Retrieves the content of the current page.
8-
- [getHTML](getHTML.md) - Retrieves the HTML content of the current page.
9-
- [getMarkdown](getMarkdown.md) - Retrieves the Markdown content of the current page.
10-
- [getPDF](getPDF.md) - Retrieves the PDF content of the current page.
11-
- [getUrl](getUrl.md) - Retrieves the current URL of the browser's active page.
12-
- [goToPage](goToPage.md) - Navigates to a specified URL.
13-
- [newPage](newPage.md) - Opens a new page in the browser.
14-
- [pdfToText](pdfToText.md) - Converts the PDF content of the current page to text.
15-
- [screenshot](screenshot.md) - Takes a screenshot of the current page.
16-
- [scroll](scroll.md) - Scrolls the current page in a specified direction by a specified number of pixels.
17-
- [search](search.md) - Performs a search on the current page using a specified query.
18-
- [type](type.md) - Types text into a specified element on the page.
1+
---
2+
cbapicategory:
3+
- name: click
4+
link: click.md
5+
description: Clicks on a specified element on the page.
6+
- name: close
7+
link: close.md
8+
description: Closes the current page.
9+
- name: enter
10+
link: enter.md
11+
description: Simulates the Enter key press on the current page.
12+
- name: extractText
13+
link: extractText.md
14+
description: Extracts text from the current page.
15+
- name: getContent
16+
link: getContent.md
17+
description: Retrieves the content of the current page.
18+
- name: getHTML
19+
link: getHTML.md
20+
description: Retrieves the HTML content of the current page.
21+
- name: getMarkdown
22+
link: getMarkdown.md
23+
description: Retrieves the Markdown content of the current page.
24+
- name: getPDF
25+
link: getPDF.md
26+
description: Retrieves the PDF content of the current page.
27+
- name: getUrl
28+
link: getUrl.md
29+
description: Retrieves the current URL of the browser's active page.
30+
- name: goToPage
31+
link: goToPage.md
32+
description: Navigates to a specified URL.
33+
- name: newPage
34+
link: newPage.md
35+
description: Opens a new page in the browser.
36+
- name: pdfToText
37+
link: pdfToText.md
38+
description: Converts the PDF content of the current page to text.
39+
- name: screenshot
40+
link: screenshot.md
41+
description: Takes a screenshot of the current page.
42+
- name: scroll
43+
link: scroll.md
44+
description: Scrolls the current page in a specified direction by a specified number of pixels.
45+
- name: search
46+
link: search.md
47+
description: Performs a search on the current page using a specified query.
48+
- name: type
49+
link: type.md
50+
description: Types text into a specified element on the page.
51+
---
52+
# browser
53+
<CBAPICategory />

‎docs/api/cbstate/cb_index.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1+
---
2+
cbapicategory:
3+
- name: getApplicationState
4+
link: getApplicationState.md
5+
description:
6+
---
17
# cbstate
2-
- [getApplicationState](getApplicationState.md) -
8+
<CBAPICategory />

‎docs/api/chat/cb_index.md

+22-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,23 @@
1+
---
2+
cbapicategory:
3+
- name: eventEmitter
4+
link: eventEmitter.md
5+
description:
6+
- name: stopProcess
7+
link: stopProcess.md
8+
description:
9+
- name: getChatHistory
10+
link: getChatHistory.md
11+
description:
12+
- name: processStarted
13+
link: processStarted.md
14+
description:
15+
- name: sendMessage
16+
link: sendMessage.md
17+
description:
18+
- name: waitforReply
19+
link: waitforReply.md
20+
description:
21+
---
122
# chat
2-
- [eventEmitter](eventEmitter.md) -
3-
- [stopProcess](stopProcess.md) -
4-
- [getChatHistory](getChatHistory.md) -
5-
- [processStarted](processStarted.md) -
6-
- [sendMessage](sendMessage.md) -
7-
- [waitforReply](waitforReply.md) -
23+
<CBAPICategory />

‎docs/api/codeparsers/cb_index.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1+
---
2+
cbapicategory:
3+
- name: getAstTreeInFile
4+
link: getAstTreeInFile.md
5+
description: Generates an Abstract Syntax Tree (AST) for a given file.
6+
- name: getClassesInFile
7+
link: getClassesInFile.md
8+
description: Retrieves the classes in a given file.
9+
- name: getFunctionsinClass
10+
link: getFunctionsinClass.md
11+
description: Retrieves the functions in a given class within a file.
12+
---
113
# codeparsers
2-
- [getAstTreeInFile](getAstTreeInFile.md) - Generates an Abstract Syntax Tree (AST) for a given file.
3-
- [getClassesInFile](getClassesInFile.md) - Retrieves the classes in a given file.
4-
- [getFunctionsinClass](getFunctionsinClass.md) - Retrieves the functions in a given class within a file.
14+
<CBAPICategory />

‎docs/api/codeutils/cb_index.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
cbapicategory:
3+
- name: getAllFilesAsMarkDown
4+
link: getAllFilesAsMarkDown.md
5+
description:
6+
- name: getCodeTree
7+
link: getCodeTree.md
8+
description: Asynchronously generates a code tree from the provided source code.
9+
---
110
# codeutils
2-
- [getAllFilesAsMarkDown](getAllFilesAsMarkDown.md) -
3-
- [getCodeTree](getCodeTree.md) - Asynchronously generates a code tree from the provided source code.
11+
<CBAPICategory />

‎docs/api/constructor/_category_.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"label": "constructor",
3+
"position": 2.5,
4+
"collapsible": true,
5+
"collapsed": true,
6+
"className": "red",
7+
"link": {
8+
"type": "doc",
9+
"id": "cb_index"
10+
}
11+
}

‎docs/api/constructor/cb_index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
cbapicategory:
3+
---
4+
# constructor
5+
<CBAPICategory />

‎docs/api/crawler/cb_index.md

+28-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,29 @@
1+
---
2+
cbapicategory:
3+
- name: click
4+
link: click.md
5+
description: Simulates a click event on an element with the specified ID.
6+
- name: crawl
7+
link: crawl.md
8+
description: Initiates a crawl process.
9+
- name: enter
10+
link: enter.md
11+
description: Simulates the Enter key press using the crawler.
12+
- name: goToPage
13+
link: goToPage.md
14+
description: Directs the crawler to navigate to a specified URL.
15+
- name: screenshot
16+
link: screenshot.md
17+
description: Takes a screenshot using the crawler.
18+
- name: scroll
19+
link: scroll.md
20+
description: Scrolls the crawler in a specified direction.
21+
- name: start
22+
link: start.md
23+
description: Starts the crawler.
24+
- name: type
25+
link: type.md
26+
description: Types the provided text into an element with the specified ID.
27+
---
128
# crawler
2-
- [click](click.md) - Simulates a click event on an element with the specified ID.
3-
- [crawl](crawl.md) - Initiates a crawl process.
4-
- [enter](enter.md) - Simulates the Enter key press using the crawler.
5-
- [goToPage](goToPage.md) - Directs the crawler to navigate to a specified URL.
6-
- [screenshot](screenshot.md) - Takes a screenshot using the crawler.
7-
- [scroll](scroll.md) - Scrolls the crawler in a specified direction.
8-
- [start](start.md) - Starts the crawler.
9-
- [type](type.md) - Types the provided text into an element with the specified ID.
29+
<CBAPICategory />

‎docs/api/dbmemory/cb_index.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
cbapicategory:
3+
- name: addKnowledge
4+
link: addKnowledge.md
5+
description: Adds a key-value pair to the in-memory database.
6+
- name: getKnowledge
7+
link: getKnowledge.md
8+
description: Retrieves a value from the in-memory database by key.
9+
---
110
# dbmemory
2-
- [addKnowledge](addKnowledge.md) - Adds a key-value pair to the in-memory database.
3-
- [getKnowledge](getKnowledge.md) - Retrieves a value from the in-memory database by key.
11+
<CBAPICategory />

‎docs/api/debug/cb_index.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
cbapicategory:
3+
- name: debug
4+
link: debug.md
5+
description:
6+
- name: openDebugBrowser
7+
link: openDebugBrowser.md
8+
description:
9+
---
110
# debug
2-
- [debug](debug.md) -
3-
- [openDebugBrowser](openDebugBrowser.md) -
11+
<CBAPICategory />

‎docs/api/docutils/cb_index.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1+
---
2+
cbapicategory:
3+
- name: pdf_to_text
4+
link: pdf_to_text.md
5+
description: Converts a PDF document to text.
6+
---
17
# docutils
2-
- [pdf_to_text](pdf_to_text.md) - Converts a PDF document to text.
8+
<CBAPICategory />

‎docs/api/fs/cb_index.md

+25-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,26 @@
1+
---
2+
cbapicategory:
3+
- name: createFile
4+
link: createFile.md
5+
description:
6+
- name: createFolder
7+
link: createFolder.md
8+
description:
9+
- name: deleteFile
10+
link: deleteFile.md
11+
description:
12+
- name: deleteFolder
13+
link: deleteFolder.md
14+
description:
15+
- name: listFile
16+
link: listFile.md
17+
description:
18+
- name: readFile
19+
link: readFile.md
20+
description:
21+
- name: updateFile
22+
link: updateFile.md
23+
description:
24+
---
125
# fs
2-
- [createFile](createFile.md) -
3-
- [createFolder](createFolder.md) -
4-
- [deleteFile](deleteFile.md) -
5-
- [deleteFolder](deleteFolder.md) -
6-
- [listFile](listFile.md) -
7-
- [readFile](readFile.md) -
8-
- [updateFile](updateFile.md) -
26+
<CBAPICategory />

‎docs/api/git/cb_index.md

+37-11
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,38 @@
1+
---
2+
cbapicategory:
3+
- name: add
4+
link: add.md
5+
description: Adds changes in the local repository to the staging area at the given path.
6+
- name: branch
7+
link: branch.md
8+
description: Creates a new branch in the local repository at the given path.
9+
- name: checkout
10+
link: checkout.md
11+
description: Checks out a branch or commit in the local repository at the given path.
12+
- name: clone
13+
link: clone.md
14+
description: Clones a Git repository from the given URL to the specified path.
15+
- name: commit
16+
link: commit.md
17+
description: Commits the staged changes in the local repository with the given commit message.
18+
- name: diff
19+
link: diff.md
20+
description: Retrieves the diff of changes for a specific commit in the local repository.
21+
- name: init
22+
link: init.md
23+
description: Initializes a new Git repository at the given path.
24+
- name: logs
25+
link: logs.md
26+
description: Retrieves the commit logs for the local repository at the given path.
27+
- name: pull
28+
link: pull.md
29+
description: Pulls the latest changes from the remote repository to the local repository at the given path.
30+
- name: push
31+
link: push.md
32+
description: Pushes local repository changes to the remote repository at the given path.
33+
- name: status
34+
link: status.md
35+
description: Retrieves the status of the local repository at the given path.
36+
---
137
# git
2-
- [add](add.md) - Adds changes in the local repository to the staging area at the given path.
3-
- [branch](branch.md) - Creates a new branch in the local repository at the given path.
4-
- [checkout](checkout.md) - Checks out a branch or commit in the local repository at the given path.
5-
- [clone](clone.md) - Clones a Git repository from the given URL to the specified path.
6-
- [commit](commit.md) - Commits the staged changes in the local repository with the given commit message.
7-
- [diff](diff.md) - Retrieves the diff of changes for a specific commit in the local repository.
8-
- [init](init.md) - Initializes a new Git repository at the given path.
9-
- [logs](logs.md) - Retrieves the commit logs for the local repository at the given path.
10-
- [pull](pull.md) - Pulls the latest changes from the remote repository to the local repository at the given path.
11-
- [push](push.md) - Pushes local repository changes to the remote repository at the given path.
12-
- [status](status.md) - Retrieves the status of the local repository at the given path.
38+
<CBAPICategory />

‎docs/api/knowledge/cb_index.md

+4
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1+
---
2+
cbapicategory:
3+
---
14
# knowledge
5+
<CBAPICategory />

‎docs/api/llm/cb_index.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1-
# llm
2-
- [inference](inference.md) - Sends an inference request to the LLM and returns the model's response.
1+
---
2+
cbapicategory:
3+
- name: inference
4+
link: inference.md
5+
description: Sends an inference request to the LLM and returns the model's response.
36
The model is selected based on the provided
7+
---
8+
# llm
9+
<CBAPICategory />

‎docs/api/outputparsers/cb_index.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
1-
# outputparsers
2-
- [init](init.md) - Initializes the output parser module.
1+
---
2+
cbapicategory:
3+
- name: init
4+
link: init.md
5+
description: Initializes the output parser module.
36
Currently, this function does not perform any operations.
4-
- [parseErrors](parseErrors.md) - Parses the given output and returns all the error messages.
5-
- [parseWarnings](parseWarnings.md) - Parses the given output and returns all the warning messages.
7+
- name: parseErrors
8+
link: parseErrors.md
9+
description: Parses the given output and returns all the error messages.
10+
- name: parseWarnings
11+
link: parseWarnings.md
12+
description: Parses the given output and returns all the warning messages.
13+
---
14+
# outputparsers
15+
<CBAPICategory />

‎docs/api/project/cb_index.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
# project
2-
- [getProjectPath](getProjectPath.md) - Retrieves the path of the current project.
3-
- [getProjectSettings](getProjectSettings.md) - Placeholder for a method to get project settings.
1+
---
2+
cbapicategory:
3+
- name: getProjectPath
4+
link: getProjectPath.md
5+
description: Retrieves the path of the current project.
6+
- name: getProjectSettings
7+
link: getProjectSettings.md
8+
description: Placeholder for a method to get project settings.
49
Currently, this method does not perform any operations.
10+
---
11+
# project
12+
<CBAPICategory />

‎docs/api/rag/cb_index.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,14 @@
1+
---
2+
cbapicategory:
3+
- name: add_file
4+
link: add_file.md
5+
description: Adds a file to the CodeBolt File System.
6+
- name: init
7+
link: init.md
8+
description: Initializes the CodeBolt File System Module.
9+
- name: retrieve_related_knowledge
10+
link: retrieve_related_knowledge.md
11+
description: Retrieves related knowledge for a given query and filename.
12+
---
113
# rag
2-
- [add_file](add_file.md) - Adds a file to the CodeBolt File System.
3-
- [init](init.md) - Initializes the CodeBolt File System Module.
4-
- [retrieve_related_knowledge](retrieve_related_knowledge.md) - Retrieves related knowledge for a given query and filename.
14+
<CBAPICategory />

0 commit comments

Comments
 (0)