Skip to content

Commit 8c8e36b

Browse files
committed
updated the docs
1 parent 193a955 commit 8c8e36b

14 files changed

+63
-61
lines changed

docs/agents/1_agentIntroduction.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_label: Introduction
3+
---
4+
15
# Agent Introduction
26

37
Codebolt is an extremely powerful tool for AI Code Editing and AI Code Generation. Most of the power of Codebolt comes from the ability to use Agents. These agents are powerful tools that can be used to automate tasks, generate code, and even create entire applications.
@@ -6,7 +10,6 @@ Codebolt is an extremely powerful tool for AI Code Editing and AI Code Generatio
610

711
Codebolt uses AI Agents for doing all the actions. Thing of Codebolt Editor as a big Agent Orchestrator that can use any agent in the marketplace to do any task.
812
AI Agents interface with Codebolt using Codebolt Editor APIs. They can run any logic from talking to LLMs, updating the code, and any other tasks. They can use decision making power of LLMs to make decisions and take actions.
9-
1013
<!-- ## Codebolt Editor APIs
1114
1215
Codebolt Editor exposes all the functionality of the Editor in the format of APIs. We have created various Libraries to access the Editor APIs. These libraries are available in the following languages:
@@ -25,3 +28,4 @@ Universal Agents are called whenever the user sends any chat in the editor or as
2528
### Action Agents
2629
Action Agents are called whenever the user sends any chat in the editor or asks to perform any action that can be resolved to any agent. You can learn more about them at [Action Agents](./AgentTypes/actionAgents.md) -->
2730

31+

docs/agents/1_agentarchitecture/1_architecture.md

Whitespace-only changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"position": 3,
3+
"label": "What is an Agent?",
4+
"collapsible": true,
5+
"collapsed": true
6+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
sidebar_label: QuickStart
3+
---

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

+3-3
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](../../../static/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](../../../static/img/selectMarketplaceAgent.png)
2727

28-
![runAgent2](../../static/img/SelectFormAgent.png)
28+
![runAgent2](../../../static/img/SelectFormAgent.png)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"position": 3,
3+
"label": "Using Agents",
4+
"collapsible": true,
5+
"collapsed": true
6+
}

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

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
sidebar_label: First Extension
3+
---
4+
15
# Creating Your First Codebolt Agent
26

37
This guide will walk you through the process of creating your first custom Codebolt agent. Custom agents allow you to extend Codebolt's functionality with your own AI-powered tools.
@@ -18,15 +22,15 @@ To begin creating a new agent:
1822
1. **Open Codebolt** and navigate to the chat interface.
1923
2. **Click on the "Create Agent" button** in the chat window. This option is typically found in the sidebar or main interface.
2024

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

2327
### 2. Select Agent Type
2428

2529
Next, you'll need to choose the type of agent you want to create:
2630

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

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

3135
### 3. Configure Your Agent
3236

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

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

4044
### 4. Creation Confirmation
4145

4246
After configuring your agent, the system will create the necessary files and structure:
4347

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

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

4852
### 5. Explore Generated Code
4953

@@ -54,7 +58,7 @@ Codebolt will generate a starter code structure for your agent:
5458
- Configuration files
5559
- Dependencies and setup scripts
5660

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

5963
### 6. Understanding the Agent Structure
6064

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

+5-5
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](../../../static/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](../../../static/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](../../../static/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](../../../static/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
@@ -39,6 +39,6 @@ This guide will walk you through the process of running a local agent in Codebol
3939
## Additional Information
4040
- Local agents run directly on your machine, ensuring your code and queries remain private
4141
- You can switch between different agents at any time by repeating the selection process
42-
- For information on creating your own custom agent, refer to our [Agent Development Guide](./2_firstExtension.md)
42+
- For information on creating your own custom agent, refer to our [Agent Development Guide](../2_firstExtension.md)
4343

4444

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

+1-1
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](../../../static/img/publish_agent.png)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"position": 3,
3+
"label": "Code Based Agents",
4+
"collapsible": true,
5+
"collapsed": true
6+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_label: About Remix Agents
3+
---
4+
5+
# About Remix Agents
6+
7+
Remix Agents are a type of agent that allows you to remix existing agents to create new ones.
8+
9+
## How to use Remix Agents
10+
11+
1. Go to the Remix Agents page
12+
2. Click on the agent you want to remix
13+
3. Click on the remix button
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"position": 3,
3+
"label": "Remix Agents",
4+
"collapsible": true,
5+
"collapsed": true
6+
}

docs/agents/modules/1_index.md

-7
This file was deleted.

docs/agents/modules/2_browser.md

-39
This file was deleted.

0 commit comments

Comments
 (0)