updated the docs

Author: utkarshx

docs/api/websocket/_category_.json renamed to docs/api/_category_.json

@@ -1,11 +1,11 @@
 {
-  "label": "websocket",
+  "label": "Api",
   "position": 2.5,
   "collapsible": true,
   "collapsed": true,
   "className": "red",
   "link": {
     "type": "doc",
-    "id": "cb_index"
+    "id": "api_index"
   }
 }

docs/api/api_index.md

@@ -0,0 +1,72 @@
+---
+cbapicategory:
+    - name: Browser
+      link: browser/cb_index
+      description: The browser module provides functions for interacting with the browser.
+    - name: Cbstate
+      link: cbstate/cb_index
+      description: This is a state module that gives the current state. The state is being continuously updated by the application based on various actions.
+    - name: Chat
+      link: chat/cb_index
+      description: This has various chat related functionalities where the agent can send chat to user and get the user response
+    - name: CodeParsers
+      link: codeparsers/cb_index
+      description: This is a module that parses the code and returns the code tree.
+    - name: CodeUtils
+      link: codeutils/cb_index
+      description: This is a module that provides various utilities for parsing and manipulating code.
+    - name: Crawler
+      link: crawler/cb_index
+      description: This is a module that crawls the web and returns the crawled data.
+    - name: DbMemory
+      link: dbmemory/cb_index
+      description: This is a module that provides memory based database functionalities.
+    - name: Debug
+      link: debug/cb_index
+      description: This is a module that provides various debug functionalities.
+    - name: DocUtils
+      link: docutils/cb_index
+      description: This is a module that provides various utilities for parsing and manipulating markdown.
+    - name: Fs
+      link: fs/cb_index
+      description: This is a module that provides various file system functionalities.
+    - name: Git
+      link: git/cb_index
+      description: This is a module that provides various git functionalities.
+    - name: Knowledge
+      link: knowledge/cb_index
+      description: This is a module that provides various knowledge related functionalities.
+    - name: LLM
+      link: llm/cb_index
+      description: This is a module that provides various LLM related functionalities.
+    - name: OutputParsers
+      link: outputparsers/cb_index
+      description: This is a module that parses the output and returns the output tree.
+    - name: Project
+      link: project/cb_index
+      description: This is a module that provides various project related functionalities.
+    - name: Rag
+      link: rag/cb_index
+      description: This is a module that provides various RAG related functionalities.
+    - name: Search
+      link: search/cb_index
+      description: This is a module that provides various search related functionalities.
+    - name: TaskPlanner
+      link: taskplaner/cb_index
+      description: This is a module that provides various task planner related functionalities.
+    - name: Terminal
+      link: terminal/cb_index
+      description: Handle Terminal Related Functionalities like Running Commands and Getting Output. Supports handling multiple terminals and long running code executions like Servers.
+    - name: Tokenizer
+      link: tokenizer/cb_index
+      description: Tokenization related Functionalities are provided so that the code can be tokenized and the tokens can be used to perform and measure various operations.
+    - name: VectorDB
+      link: vectordb/cb_index
+      description: Provides Vector DB related Functionalities for Storing and Managing of Vector Embedding
+
+---
+# Codebolt AI Agent Framework API
+
+## Overview
+
+<CBAPICategory />

docs/api/browser/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "browser",
+  "label": "Browser",
   "position": 2.5,
   "collapsible": true,
   "collapsed": true,

docs/api/browser/cb_index.md

@@ -1,4 +1,5 @@
-# browser
+# Browser
+
 - [click](click.md) - Clicks on a specified element on the page.
 - [close](close.md) - Closes the current page.
 - [enter](enter.md) - Simulates the Enter key press on the current page.

docs/api/constructor/_category_.json

@@ -71,10 +71,26 @@ function writeClassIndex(categoryName, indexFilePath, classAllFrontMatters) {
   fs.writeFileSync(indexFilePath, classIndexContent);
 }
 
+// function writeAPIIndex(){
+
+// }
+
+// let allClasses = [];
+// let classDetails = {
+//   "name": " ",
+//   "description": " ",
+//   "link": " "
+// };
 
 
 if (codeboltChild && codeboltChild.children) {
   codeboltChild.children.forEach(CbProperties => {
+
+    // classDetails.name = CbProperties.name;
+    // classDetails.description = CbProperties.comment && CbProperties.comment.summary && CbProperties.comment.summary.length > 0 ? CbProperties.comment.summary[0].text : ' ';
+    // classDetails.link = `${CbProperties.name}`;
+
+
     const dir = `../docs/api/${CbProperties.name}`;
 
     let classAllFrontMatters = [];

docs/api/constructor/cb_index.md

@@ -0,0 +1,34 @@
+/**
+ * This is a custom Front Matter Component that takes the front matter and renders the api data
+ */
+import React from "react";
+import useFrontMatter from "./useFrontMatter";
+
+const CBAPICategory = () => {
+  const frontMatter = useFrontMatter();
+  console.log(frontMatter)
+  console.log(Object.entries(frontMatter))
+  return (
+    <div>
+      {Object.entries(frontMatter).map(([key, value]) => {
+        console.log(key)
+        if (key === "cbapicategory") {
+          console.log(value);
+          return (
+            <ul>
+              {value.map((item, index) => (
+                <li key={index}>
+                  <a href={item.link}>{item.name}</a> - {item.description}
+                </li>
+              ))}
+            </ul>
+          );
+        }
+        
+        return null;
+      })}
+    </div>
+  );
+};
+
+export default CBAPICategory;

docs/api/start_browser/_category_.json

@@ -6,23 +6,13 @@ import useFrontMatter from "./useFrontMatter";
 
 const CBBaseInfo = () => {
   const frontMatter = useFrontMatter();
-  console.log(frontMatter);
   return (
     <div>
       {Object.entries(frontMatter).map(([key, value]) => {
         if (key === "cbbaseinfo") {
           console.log(`Key: ${key}, Value: ${value}`);
 
           return <div className="description" key={key}>Description: {value.description}</div>;
-          // return Object.entries(value).map(([cbkey, cbvalue]) => {
-          //   console.log(cbkey);
-          //   return (
-          //     <p key={cbkey}>
-          //       <strong>{cbkey}</strong>
-          //       <br/>
-          //     </p>
-          //   );
-          // });
         }
 
         return null;

docs/api/start_browser/cb_index.md

@@ -6,12 +6,14 @@ import React from 'react';
 import {MDXProvider} from '@mdx-js/react';
 import CBBaseInfo from './CBBaseInfo';
 import CBParameters from './CBParameters';
+import CBAPICategory from './CBAPICategory';
 import FrontMatterContext from './FrontMatterContext';
 
 
 const components = {
   CBBaseInfo: props => <CBBaseInfo {...props} />,
-  CBParameters: props => <CBParameters {...props} />
+  CBParameters: props => <CBParameters {...props} />,
+  CBAPICategory: props => <CBAPICategory {...props} />
 };
 
 const CBProvider = ({children, frontMatter}) => (