add example and explaination

Author: Nursid

Diff for: docs/api/docutils/pdf_to_text.md

@@ -19,4 +19,8 @@ data:
   link: pdf_to_text.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/fs/createFile.md

@@ -25,4 +25,23 @@ data:
   link: createFile.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example 
+
+```js
+// Let's assume you want to create a text file named hello.txt in the /home/user/documents directory with the content "Hello, world!" 
+
+codebolt.fs.createFile('hello.txt', 'Hello, world!', '/home/user/documents');
+
+```
+
+### Explaination
+
+The codebolt.fs.createFile method is used to create a new file in a specified directory, with content provided as a string. It has three parameters:
+
+fileName (string): This parameter specifies the name of the file to be created. The name should include the file extension (e.g., "example.txt", "data.json").
+
+source (string): This parameter contains the content that will be written into the newly created file. It can be any string data that you want to save in the file.
+
+filePath (string): This parameter defines the path where the file will be created. It should be a valid path in the filesystem where you have write permissions.

Diff for: docs/api/fs/createFolder.md

@@ -22,4 +22,22 @@ data:
   link: createFolder.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example 
+
+```js
+
+//Let's assume you want to create a folder named newFolder in the /home/user/documents directory.
+
+codebolt.fs.createFolder('newFolder', '/home/user/documents');
+
+```
+
+### Explaination
+
+The codebolt.fs.createFolder method is used to create a new folder in a specified directory. It has two parameters:
+
+folderName (string): The name of the folder to be created.
+
+folderPath (string): The path where the folder will be created.

Diff for: docs/api/fs/deleteFile.md

@@ -22,4 +22,12 @@ data:
   link: deleteFile.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example 
+
+The codebolt.fs.deleteFile method is used to delete a specified file from a given directory. It has two parameters:
+
+filename (string): The name of the file to be deleted, including the file extension (e.g., "example.txt", "data.json").
+
+filePath (string): The path to the directory where the file is located.

Diff for: docs/api/fs/deleteFolder.md

@@ -22,4 +22,22 @@ data:
   link: deleteFolder.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example 
+
+```js 
+//Let's assume you want to delete a folder named oldFolder in the /home/user/documents directory.
+
+codebolt.fs.deleteFolder('oldFolder', '/home/user/documents');
+
+```
+
+
+### Explaination
+
+The codebolt.fs.deleteFolder method is used to delete a specified folder from a given directory. It has two parameters:
+
+foldername (string): The name of the folder to be deleted.
+
+folderpath (string): The path to the directory where the folder is located.

Diff for: docs/api/fs/listFile.md

@@ -17,4 +17,8 @@ data:
   link: listFile.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/fs/readFile.md

@@ -22,4 +22,22 @@ data:
   link: readFile.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example 
+
+```js
+
+// Let's assume you want to read the content of a file named example.txt in the /home/user/documents directory.
+
+codebolt.fs.readFile('example.txt', '/home/user/documents');
+
+```
+
+### Explaination
+
+The codebolt.fs.readFile method is used to read the content of a specified file from a given directory. It has two parameters:
+
+filename (string): The name of the file to be read, including the file extension (e.g., "example.txt", "data.json").
+
+filePath (string): The path to the directory where the file is located. It should be a valid path in the filesystem where you have read permissions.

Diff for: docs/api/fs/updateFile.md

@@ -25,4 +25,8 @@ data:
   link: updateFile.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status
+
+Working Progress...

Diff for: docs/api/git/add.md

@@ -19,4 +19,8 @@ data:
   link: add.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/git/branch.md

@@ -22,4 +22,8 @@ data:
   link: branch.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/git/checkout.md

@@ -22,4 +22,8 @@ data:
   link: checkout.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/git/clone.md

@@ -22,4 +22,8 @@ data:
   link: clone.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/git/commit.md

@@ -21,4 +21,18 @@ data:
   link: commit.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example 
+
+```js
+
+const commitMessage = await codebolt.git.commit('test');
+
+```
+
+
+
+### Explaination 
+
+To use the codebolt.git.commit method properly, you need to understand how to make a commit in a Git repository using this method. The codebolt.git.commit function is likely used to commit changes in a Git repository with a specified commit message.

Diff for: docs/api/git/diff.md

@@ -22,4 +22,8 @@ data:
   link: diff.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/git/init.md

@@ -19,4 +19,9 @@ data:
   link: init.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Status 
+
+Work Progress...

Diff for: docs/api/git/logs.md

@@ -19,4 +19,8 @@ data:
   link: logs.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Work Progress...

Diff for: docs/api/git/pull.md

@@ -21,4 +21,8 @@ data:
   link: pull.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Work Progress...

Diff for: docs/api/git/push.md

@@ -19,4 +19,8 @@ data:
   link: push.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Work Progress...

Diff for: docs/api/git/status.md

@@ -19,4 +19,8 @@ data:
   link: status.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status
+
+Work Progress...

Diff for: docs/api/llm/inference.md

@@ -24,4 +24,26 @@ data:
   link: inference.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Example 
+
+```js 
+
+const question = "Write an API to get all users from the User Table.";
+const llmRole = "assistant";
+
+const response = codebolt.llm.inference(question, llmRole);
+console.log(response);
+
+
+```
+
+
+### Explaination
+
+The codebolt.llm.inference function allows you to send an inference request to a Large Language Model (LLM) and retrieves the model's response. It has two parameter: 
+
+question (string): This parameter represents the input question or prompt you want to send to the LLM for inference.
+
+llmRole (string): This parameter specifies the role or type of Large Language Model (LLM) you want to use for inference. The role determines which variant of the LLM is selected for processing the input question and generating the response.

Diff for: docs/api/outputparsers/init.md

@@ -19,4 +19,8 @@ data:
   link: init.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/outputparsers/parseErrors.md

@@ -16,4 +16,8 @@ data:
   link: parseErrors.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/outputparsers/parseWarnings.md

@@ -16,4 +16,8 @@ data:
   link: parseWarnings.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...

Diff for: docs/api/project/getProjectPath.md

@@ -16,4 +16,16 @@ data:
   link: getProjectPath.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+
+### Example 
+
+```js 
+
+const getpath = await codebolt.project.getProjectPath();
+
+```
+### Explaination
+
+The codebolt.project.getProjectPath() function is likely used to retrieve the path of the current project.

Diff for: docs/api/project/getProjectSettings.md

@@ -19,4 +19,8 @@ data:
   link: getProjectSettings.md
 ---
 <CBBaseInfo/> 
- <CBParameters/>
+ <CBParameters/>
+
+### Status 
+
+Working Progress...