example and explaination updated

Nursid · Nursid · commit bca1514f1c17 · 2024-06-06T18:47:51.000+05:30
diff --git a/docs/api/browser/click.md b/docs/api/browser/click.md
@@ -21,7 +21,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples
+### Example
 
 ```js
 // Using Codebolt's browser API, you can interact with elements on a web page.
diff --git a/docs/api/browser/close.md b/docs/api/browser/close.md
@@ -16,16 +16,17 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples
- ```js
+### Example
+
+```js
  // Open the browser and navigate to a specific URL
- codebolt.browser.goToPage(url);
+codebolt.browser.goToPage(url);
 
 // Perform tests on the web page
 // (Assume you have performed all necessary tests)
 
 // Close the current page
- codebolt.browser.close();
+codebolt.browser.close();
 
  ```
 ### Explaination
diff --git a/docs/api/browser/enter.md b/docs/api/browser/enter.md
@@ -18,7 +18,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples 
+### Example
 
 ```js
 
diff --git a/docs/api/browser/extractText.md b/docs/api/browser/extractText.md
@@ -16,7 +16,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples: 
+### Example 
 
 ```js
 // Navigate to the news website
diff --git a/docs/api/browser/getContent.md b/docs/api/browser/getContent.md
@@ -20,3 +20,22 @@ data:
 ### Status 
 Working Progress...
 
+
+### Example 
+
+```js 
+
+// Navigate to the product page
+await codebolt.browser.goToPage("https://example-ecommerce.com/product/12345")
+
+// Retrieve the get content of the current page
+const getContent = await codebolt.browser.getContent()
+
+console.log(getContent)
+
+```
+
+
+### Explaination 
+
+The codebolt.browser.getContent() method is used to capture the entire content of the webpage that is currently loaded. This includes the HTML, text, and other elements present on the page. The codebolt.browser.getContent() function is used to retrieve the HTML content of the current web page. This function is particularly useful for web scraping, data extraction, and automated testing scenarios where you need to capture the content of a web page for further analysis or processing.
diff --git a/docs/api/browser/getHTML.md b/docs/api/browser/getHTML.md
@@ -19,7 +19,7 @@ data:
  <CBParameters/>
 
 
-### Examples :
+### Example
 
 ```js
 
diff --git a/docs/api/browser/getMarkdown.md b/docs/api/browser/getMarkdown.md
@@ -18,7 +18,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples: 
+### Example
 
 ```js
 
diff --git a/docs/api/browser/getPDF.md b/docs/api/browser/getPDF.md
@@ -20,3 +20,19 @@ data:
 ### Status 
 Working Progress...
 
+
+### Example
+
+```js
+
+
+await codebolt.browser.goToPage("https://example-ecommerce.com/product/12345")
+
+
+const getPDF = await codebolt.browser.getPDF()
+
+```
+
+### Explaination 
+
+The codebolt.browser.getPDF() method is designed to capture the content of the current webpage and generate a PDF file from it. This is useful for saving web pages as PDFs for offline reading, documentation, or record-keeping.
diff --git a/docs/api/browser/getUrl.md b/docs/api/browser/getUrl.md
@@ -19,7 +19,7 @@ data:
  <CBParameters/>
 
 
-### Examples: 
+### Example
 
 ```js
 
diff --git a/docs/api/browser/goToPage.md b/docs/api/browser/goToPage.md
@@ -21,7 +21,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples
+### Example
 
 ```js
 
diff --git a/docs/api/browser/newPage.md b/docs/api/browser/newPage.md
@@ -16,7 +16,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples: 
+### Example
 
 ```js
 // Open a new page in the browser
diff --git a/docs/api/browser/pdfToText.md b/docs/api/browser/pdfToText.md
@@ -21,7 +21,7 @@ data:
 
 Working Progress...
 
-<!-- ### Examples: 
+### Example
 
 ```js
 
@@ -34,4 +34,4 @@ codebolt.browser.pdfToText();
 ```
 
 ### Explanation
-The codebolt.browser.pdfToText() function is used to convert the PDF content of the current page into text format. This function is particularly useful when dealing with PDF documents in web automation or data extraction scenarios where you need to extract textual information from PDF files. -->
+The codebolt.browser.pdfToText() function is used to convert the PDF content of the current page into text format. This function is particularly useful when dealing with PDF documents in web automation or data extraction scenarios where you need to extract textual information from PDF files. 
diff --git a/docs/api/browser/screenshot.md b/docs/api/browser/screenshot.md
@@ -20,7 +20,8 @@ data:
 
 Working Progress...
 
-<!-- ### Examples: 
+
+### Example 
 
 ```js 
 
@@ -35,9 +36,3 @@ codebolt.browser.screenshot();
 ### Explanation:
 
 The codebolt.browser.screenshot() function is used to capture a screenshot of the current page displayed in the browser. This function is helpful for various purposes such as visual verification, debugging, or generating documentation.
-
-### Explaination of the code: 
-
-Navigation: The script navigates to the desired web page using codebolt.browser.goToPage("https://example.com").
-
-Screenshot Capture: Once the page has loaded, the script calls codebolt.browser.screenshot() to capture a screenshot of the current page. This function takes a snapshot of the entire visible area of the web page, including all visible elements and content. -->
diff --git a/docs/api/browser/scroll.md b/docs/api/browser/scroll.md
@@ -26,7 +26,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples: 
+### Example
 
 ```js
 
@@ -36,6 +36,6 @@ await codebolt.browser.scroll("down", "500");
 
 ```
 
-### Explanation:
+### Explanation
 
 The codebolt.browser.scroll(direction: string, pixels: string) function is used to scroll the current page in a specified direction by a specified number of pixels. This function is useful for automating scrolling actions on a web page, such as navigating through lengthy content or bringing specific elements into view.
diff --git a/docs/api/browser/search.md b/docs/api/browser/search.md
@@ -25,7 +25,7 @@ data:
  <CBParameters/>
 
 
-### Examples: 
+### Example
 
 ```js
 
@@ -37,6 +37,6 @@ console.log(searchResults);
 
 ```
 
-### Explanation: 
+### Explanation
 
 The codebolt.browser.search(elementid: string, query: string) function is used to perform a search on the current page using a specified query. This function allows automation scripts to search for specific content or elements within the page.
diff --git a/docs/api/browser/type.md b/docs/api/browser/type.md
@@ -25,7 +25,7 @@ data:
  <CBParameters/>
 
 
-### Examples: 
+### Example
 
 ```js
 // Type "John Doe" into the input field with the ID "name"
diff --git a/docs/api/cbstate/addToAgentState.md b/docs/api/cbstate/addToAgentState.md
@@ -24,7 +24,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples: 
+### Example
 ```js
 // Add a user ID to the agent's state
 await codebolt.cbstate.addToAgentState("userID", "12345");
diff --git a/docs/api/cbstate/getAgentState.md b/docs/api/cbstate/getAgentState.md
@@ -19,7 +19,7 @@ data:
  <CBParameters/>
 
 
-### Examples: 
+### Example
 
 ```js
 
diff --git a/docs/api/cbstate/getApplicationState.md b/docs/api/cbstate/getApplicationState.md
@@ -18,7 +18,7 @@ data:
 <CBBaseInfo/> 
  <CBParameters/>
 
-### Examples
+### Example
 
 ```js
 // Retrieve the current application state
diff --git a/docs/api/chat/getChatHistory.md b/docs/api/chat/getChatHistory.md
@@ -21,7 +21,7 @@ data:
  <CBParameters/>
 
 
-### Examples
+### Example
 
 ```js
 // Retrieve the chat history from the server
diff --git a/docs/api/chat/stopProcess.md b/docs/api/chat/stopProcess.md
@@ -19,7 +19,7 @@ data:
  <CBParameters/>
 
 
-### Examples
+### Example
 
 ```js
 
diff --git a/docs/api/git/add.md b/docs/api/git/add.md
@@ -23,4 +23,18 @@ data:
 
 ### Status 
 
-Working Progress...
+Working Progress...
+
+### Example 
+
+```js
+
+await git.add('/path/to/repo/file.txt')
+
+```
+
+### Explaination
+
+Add changes in the specified directory to the staging area. It has one parameter.
+
+path: A string specifying the path of the directory or files to be added.
diff --git a/docs/api/git/branch.md b/docs/api/git/branch.md
@@ -26,4 +26,20 @@ data:
 
 ### Status 
 
-Working Progress...
+Working Progress...
+
+### Example 
+
+```js
+
+await git.branch('/path/to/repo', 'new-branch')
+
+```
+
+### Explaination
+
+Creates a new branch in the local repository.It has two parameter.
+
+path: A string specifying the local repository path.
+
+branch: A string specifying the new branch name.
diff --git a/docs/api/git/checkout.md b/docs/api/git/checkout.md
@@ -26,4 +26,21 @@ data:
 
 ### Status 
 
-Working Progress...
+Working Progress...
+
+
+### Example 
+
+```js 
+
+await git.checkout('/path/to/repo', 'feature-branch')
+
+```
+
+### Explaination
+
+Check out a specific branch in the local repository. It has two parameter.
+
+path: A string specifying the local repository path.
+
+branch: A string specifying the branch name to be checked out.
diff --git a/docs/api/git/clone.md b/docs/api/git/clone.md
@@ -26,4 +26,20 @@ data:
 
 ### Status 
 
-Working Progress...
+Working Progress...
+
+### Example
+
+```js
+
+await git.clone('https://github.com/user/repo.git', '/path/to/local/repo')
+
+```
+
+### Explaination 
+
+Clone an existing Git repository from a given URL to a local directory. It has two parameter.
+
+url: A string specifying the remote repository URL.
+
+path: A string specifying the local directory path where the repository should be cloned.
diff --git a/docs/api/git/diff.md b/docs/api/git/diff.md
@@ -26,4 +26,20 @@ data:
 
 ### Status 
 
-Working Progress...
+Working Progress...
+
+### Example 
+
+```js
+
+await git.diff('abc123', '/path/to/repo')
+
+```
+
+### Explaination
+
+Shows the difference between the specified commit and the current state of the repository. It has two parameter.
+
+commitHash: A string specifying the commit hash to compare against.
+
+path: A string specifying the local repository path.
diff --git a/docs/api/git/init.md b/docs/api/git/init.md
diff --git a/docs/api/git/logs.md b/docs/api/git/logs.md
diff --git a/docs/api/git/pull.md b/docs/api/git/pull.md
diff --git a/docs/api/git/push.md b/docs/api/git/push.md
diff --git a/docs/api/git/status.md b/docs/api/git/status.md
