Skip to content

Commit 3ab152f

Browse files
committed
updated the menu
1 parent 24ae34b commit 3ab152f

32 files changed

+60
-54
lines changed

docs/api/apiaccess/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ cbapicategory:
7878
---
7979
# Direct API Access
8080

81+
## Overview
82+
83+
Codebolt provides a set of APIs that can be used by agents to interact with the Codebolt application. This allows to build agents that can interact with the Codebolt application. To start using the APIs from an agent, please refer to the Codebolt Agent documentation in the Developer Guide.
84+
8185
## API List
8286

8387
<CBAPICategory />

docs/api/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_label: API Overview
2+
sidebar_label: System Interfaces
33
sidebar_position: 1
44
---
55
# CodeboltAI System Interfaces

docs/agents/2_usingagents/5_runAgent.md renamed to docs/developer/agents/2_usingagents/5_runAgent.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To use or run an agent, you’ll need to follow these steps:
1111

1212
* **Switch Agents as Needed**: If you need a different set of functions, return to your agent list to deactivate the current agent and select another. For instance, if you’re done with development and need to deploy, switch from CodeBolt Dev to CodeBolt Web Deployment for automated deployment support.
1313

14-
![selectAgent](../../../static/img/browseAgent.png)
14+
![selectAgent](/img/browseAgent.png)
1515

1616
**To use agent in chat, you can follow these steps:**
1717

@@ -23,6 +23,6 @@ In the chat interface, click on the `# symbol`. This will open list of all avail
2323

2424
* **Switch Agents if Needed**: If you need help with a different type of task, click # again to open the agent list, select another agent, and start your next interaction.
2525

26-
![runAgent2](../../../static/img/selectMarketplaceAgent.png)
26+
![runAgent2](/img/selectMarketplaceAgent.png)
2727

28-
![runAgent2](../../../static/img/SelectFormAgent.png)
28+
![runAgent2](/img/SelectFormAgent.png)

docs/agents/3_customagents/3_firstExtension.md renamed to docs/developer/agents/3_customagents/3_firstExtension.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ To begin creating a new agent:
2222
1. **Open Codebolt** and navigate to the chat interface.
2323
2. **Click on the "Create Agent" button** in the chat window. This option is typically found in the sidebar or main interface.
2424

25-
![In chat window click on create agent](../../../static/img/create-agent.png)
25+
![In chat window click on create agent](/img/create-agent.png)
2626

2727
### 2. Select Agent Type
2828

2929
Next, you'll need to choose the type of agent you want to create:
3030

3131
1. **Select "Custom Agent"** from the available options. This allows you to create an agent with your own defined functionality.
3232

33-
![Select custom agent](../../../static/img/custom-agent.png)
33+
![Select custom agent](/img/custom-agent.png)
3434

3535
### 3. Configure Your Agent
3636

@@ -39,15 +39,15 @@ Now it's time to set up the basic details for your agent:
3939
1. **Name Your Agent**: Enter a descriptive name that indicates the agent's purpose.
4040
2. **Add a Description**: Provide a brief description explaining what your agent does.
4141

42-
![Name and description for agent](../../../static/img/agent-name.png)
42+
![Name and description for agent](/img/agent-name.png)
4343

4444
### 4. Creation Confirmation
4545

4646
After configuring your agent, the system will create the necessary files and structure:
4747

4848
1. **Success Message**: You'll see a confirmation screen indicating that your agent has been successfully created.
4949

50-
![Success confirmation screen](../../../static/img/success.png)
50+
![Success confirmation screen](/img/success.png)
5151

5252
### 5. Explore Generated Code
5353

@@ -58,7 +58,7 @@ Codebolt will generate a starter code structure for your agent:
5858
- Configuration files
5959
- Dependencies and setup scripts
6060

61-
![Generated code structure](../../../static/img/code.png)
61+
![Generated code structure](/img/code.png)
6262

6363
### 6. Understanding the Agent Structure
6464

docs/agents/3_customagents/4_runExtension.md renamed to docs/developer/agents/3_customagents/4_runExtension.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,28 @@ This guide will walk you through the process of running a local agent in Codebol
88
- Open Codebolt and locate the "Agent" section in the chat window
99
- Click on the "Agent" dropdown menu in the top bar
1010

11-
![Access Agent Menu](../../../static/img/browseAgent.png)
11+
![Access Agent Menu](/img/browseAgent.png)
1212

1313
### 2. Navigate to Local Agents
1414
- Click on "Browse agents" in the dropdown menu
1515
- Select "Local agent" from the available options
1616

17-
![Select Local Agent](../../../static/img/selectLocalAgent.png)
17+
![Select Local Agent](/img/selectLocalAgent.png)
1818

1919
### 3. Select Your Agent
2020
- Browse through the list of available local agents
2121
- Each agent will display its name and basic information
2222
- Click on the agent you want to activate
2323
- The selected agent will become your active assistant
2424

25-
![Select From Local Agents](../../../static/img/selectFormAllLocalAgent.png)
25+
![Select From Local Agents](/img/selectFormAllLocalAgent.png)
2626

2727
### 4. Debug Your Agent
2828
- All debug logs will be displayed in the debug window
2929
- Use these logs to troubleshoot any issues with your agent's performance
3030
- Monitor the execution of your agent's actions in real-time
3131

32-
![Debug Agent](../../../static/img/DebugAgent.png)
32+
![Debug Agent](/img/DebugAgent.png)
3333

3434
### 5. Interact with Your Agent
3535
- Once activated, you can communicate with your local agent directly in the chat window

docs/agents/3_customagents/6_publishExtension.md renamed to docs/developer/agents/3_customagents/6_publishExtension.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ Once you're in the correct directory and logged in, publish the agent using the
2121
npx codebolt-cli publish
2222
```
2323

24-
![publish agent](../../../static/img/publish_agent.png)
24+
![publish agent](/img/publish_agent.png)

docs/agents/4_remixagents/1_aboutremixagents.md renamed to docs/developer/agents/4_remixagents/1_aboutremixagents.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ The Remix Agent is suitable for environments where there is a need for real-time
1919

2020

2121
1. Navigate to the chat window and click on the "Create Agent" option.
22-
![How to create remix agent](../../../static/img/howtocreateremix.png)
22+
![How to create remix agent](/img/howtocreateremix.png)
2323

2424
2. Select the "Remix Agent" from the options available.
25-
![Click on Remix Agent](../../../static/img/selectremix.png)
25+
![Click on Remix Agent](/img/selectremix.png)
2626

2727
3. Modify the settings of the agent you wish to remix according to your requirements.
28-
![Modify settings](../../../static/img/modifymodelormcps.png)
28+
![Modify settings](/img/modifymodelormcps.png)
2929

3030
## Using Local MCPs
3131

File renamed without changes.

docs/tools/2_create_tool.md renamed to docs/developer/tools/2_create_tool.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ You can create a new tool using either the Codebolt UI or the CLI:
1010

1111
Navigate to the Codebolt dashboard and use the tool creation interface:
1212

13-
![Codebolt tool creation interface](../../static/img/mcpcreate.png)
13+
![Codebolt tool creation interface](/img/mcpcreate.png)
1414

1515
Enter a descriptive name for your tool:
1616

17-
![Naming your Codebolt tool](../../static/img/nameyourmcp.png)
17+
![Naming your Codebolt tool](/img/nameyourmcp.png)
1818

1919
### Option 2: Using the CLI
2020

@@ -26,13 +26,13 @@ npx codebolt-cli createtool <toolName>
2626

2727
Replace `<toolName>` with a descriptive name for your tool.
2828

29-
![CLI tool creation example](../../static/img/createTool.png)
29+
![CLI tool creation example](/img/createTool.png)
3030

3131
## Tool Configuration
3232

3333
After creation, your tool will be available in the `.codeboltAgent/tool` directory within your project structure. This directory contains all configuration and implementation files needed for your tool.
3434

35-
![Tool directory structure](../../static/img/modifyyourtool.png)
35+
![Tool directory structure](/img/modifyyourtool.png)
3636

3737
## Customization Options
3838

@@ -43,7 +43,7 @@ You can customize various aspects of your tool:
4343
- Output formatting and response handling
4444
- Integration with external services
4545

46-
For detailed information on available configuration options, refer to the [Tool Configuration Reference](../api/apiaccess/tool/index.md).
46+
For detailed information on available configuration options, refer to the [Tool Configuration Reference](../../api/apiaccess/tool/index.md).
4747

4848
## Testing and Deployment
4949

docs/tools/3_testlocalmcp.md renamed to docs/developer/tools/3_testlocalmcp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ You can test your local MCP using either the graphical interface or the command-
1414

1515
Access the MCP panel by clicking the MCP icon in the Codebolt interface.
1616

17-
![Open MCP Panel](../../static/img/openMcp.png)
17+
![Open MCP Panel](/img/openMcp.png)
1818

1919
#### 2. Select Local MCP
2020

2121
From the dropdown menu, select "Local MCP" to connect to your locally running instance.
2222

23-
![Select Local MCP](../../static/img/SelectMcp.png)
23+
![Select Local MCP](/img/SelectMcp.png)
2424

2525
### Option 2: Using the CLI
2626

File renamed without changes.

docs/user/4_Templates/myTemplates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Streamline Your Workflow with Custom Templates: Codebolt enables users to upload
44

55
Seamless Integration with Codebolt: Once uploaded, your custom templates are seamlessly integrated into the Codebolt app, empowering you to kickstart new projects efficiently while leveraging your personalized settings and configurations.
66

7-
![myTemplate](../../../static/img/mytemplates.png)
7+
![myTemplate](/img/mytemplates.png)
88

99

1010
## Video Guide

docs/user/4_Templates/template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ To create a new project using a template in Codebolt, follow these steps:
1919

2020
Codebolt will then set up your project with the necessary files and configurations, and you'll be ready to start coding!
2121

22-
![Template](../../../static/img/template.png)
22+
![Template](/img/template.png)
2323

docs/user/5_Apps/publish.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,52 +7,52 @@ This guide walks you through the process of publishing your application using Co
77
2. Configure your application's basic settings
88
3. Confirm the creation process
99

10-
![create agent](../../../static/img/create-ui-app.png)
10+
![create agent](/img/create-ui-app.png)
1111

1212
## Step 2: Configure Application Settings
1313
1. Set up all application-related configurations
1414
2. Define the required parameters for your application
1515

16-
![after success](../../../static/img/app-use-setting.png)
16+
![after success](/img/app-use-setting.png)
1717

1818
## Step 3: Provide Technical Information
1919
1. Fill in all technical details about your application
2020
2. Include system requirements and compatibility information
2121

22-
![technical](../../../static/img/tech-info.png)
22+
![technical](/img/tech-info.png)
2323

2424
## Step 4: Configure Development Settings
2525
1. Set up your development environment parameters
2626
2. Define build and deployment configurations
2727

28-
![development setting](../../../static/img/develop-setting.png)
28+
![development setting](/img/develop-setting.png)
2929

3030
## Step 5: Configure Installation Settings
3131
1. Specify installation requirements and procedures
3232
2. Define any pre-installation or post-installation steps
3333

34-
![installation setting](../../../static/img/installation-setting.png)
34+
![installation setting](/img/installation-setting.png)
3535

3636
## Step 6: Configure Application Usage Settings
3737
1. Define how users will interact with your application
3838
2. Set up any required user permissions or access controls
3939

40-
![app using setting](../../../static/img/app-use-setting.png)
40+
![app using setting](/img/app-use-setting.png)
4141

4242
## Step 7: Publish Your Application
4343
1. Review all settings and configurations
4444
2. Click the "Publish" button to make your application live
4545

46-
![publish app](../../../static/img/publish-app.png)
46+
![publish app](/img/publish-app.png)
4747

4848
## Step 8: Verify Your Application Structure
4949
1. Review the final application structure
5050
2. Confirm all components are properly configured
5151

52-
![confirm](../../../static/img/confirm.png)
52+
![confirm](/img/confirm.png)
5353

5454

5555
## Step 9: Find Your Application
5656
1. Locate your newly created application
5757

58-
![find app](../../../static/img/after-install.png)
58+
![find app](/img/after-install.png)

docs/user/features/controlK.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Ctrl K
22

33

4-
![LLMs Settings](../../../static/img/llm-setting.png)
4+
![LLMs Settings](/img/llm-setting.png)
55

66
Ctrl K lets you edit and write code with the codebolt AI:
77

docs/user/features/llms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
- **LM Studio**
77
- Additionally, you can explore and choose from the **Available Models** within each provider.
88

9-
![LLMs Settings](../../../static/img/llm-setting.png)
9+
![LLMs Settings](/img/llm-setting.png)

docs/user/module/browser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Access a built-in web browser to view and interact with web content directly from the chat interface.
44

5-
![Browser](../../../static/img/browser.png)
5+
![Browser](/img/browser.png)
66

77
- Reference Video
88

docs/user/module/codeeditor/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Code Editor
22

33

4-
![codeview](../../../../static/img/codeview.png)
4+
![codeview](/img/codeview.png)
55

66
**Referance Video**
77

docs/user/module/console.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- View console output.
44
- Monitor and debug application processes and operations within the chat.
55

6-
![Console](../../../static/img/console.png)
6+
![Console](/img/console.png)
77

88
**Video Guide**
99

docs/user/module/git.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- Manage version control through the chat interface.
77

88

9-
![git](../../../static/img/git.png)
9+
![git](/img/git.png)
1010

1111
**Video Guide**
1212

docs/user/module/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Use CodeBolt's built-in chat to get help from Agent AI. Start a new conversation to ask questions, solve problems, and get coding advice instantly. Agent AI assists with coding issues and project guidance, making troubleshooting faster and easier.
44

55

6-
![Chat](../../../static/img/chat_view.png)
6+
![Chat](/img/chat_view.png)
77

88
<!-- ### Chat Features -->
99

docs/user/module/marketplace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
- Install new agents.
55
- View and manage installed agents.
66

7-
![Marketplace](../../../static/img/market_place.png)
7+
![Marketplace](/img/market_place.png)
88

99
<iframe width="100%" height="500" src="https://www.youtube.com/embed/5B7EKgU4u_Q?si=_CSlSihwK47cLQkg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

docusaurus.config.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,22 +66,22 @@ const config: Config = {
6666
type: 'docSidebar',
6767
sidebarId: 'userSidebar',
6868
position: 'left',
69-
label: 'Docs',
69+
label: 'User Guide',
7070
},
7171
{
7272
type: 'docSidebar',
7373
sidebarId: 'devSidebar',
7474
position: 'left',
75-
label: 'Agents',
76-
},
77-
{
78-
type: 'docSidebar',
79-
sidebarId: 'toolSidebar',
80-
position: 'left',
81-
label: 'Tools',
75+
label: 'Developer Guide',
8276
},
8377
// {
8478
// type: 'docSidebar',
79+
// sidebarId: 'toolSidebar',
80+
// position: 'left',
81+
// label: 'Tools',
82+
// },
83+
// {
84+
// type: 'docSidebar',
8585
// sidebarId: 'appSidebar',
8686
// position: 'left',
8787
// label: 'Apps',

sidebars.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ const sidebars: SidebarsConfig = {
1414
// By default, Docusaurus generates a sidebar from the docs folder structure
1515
jsapiSidebar: [{type: 'autogenerated', dirName: 'api'}],
1616
userSidebar: [{type: 'autogenerated', dirName: 'user'}],
17-
devSidebar: [{type: 'autogenerated', dirName: 'agents'}],
17+
devSidebar: [{type: 'autogenerated', dirName: 'developer'}],
1818
// appSidebar: [{type: 'autogenerated', dirName: 'apps'}],
19-
toolSidebar: [{type: 'autogenerated', dirName: 'tools'}],
19+
// toolSidebar: [{type: 'autogenerated', dirName: 'tools'}],
2020

2121
// But you can create a sidebar manually
2222

0 commit comments

Comments
 (0)