Skip to content

Commit e9907d3

Browse files
committed
updated
1 parent 1a93c09 commit e9907d3

21 files changed

+99
-7
lines changed

docs/agents/2_firstExtension.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Create your First Extension
1+
# Create your First Agent
22

33

44
## Create Codebolt Agent

docs/agents/3_publishExtension.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# Publish Extension
2+
# Publish Agent
33

44
### Publish an Agent Using codebolt-cli
55

File renamed without changes.

docs/agents/AgentTypes/UniversalAgents/agentGraph.md

-1
This file was deleted.

docs/agents/AgentTypes/UniversalAgents/taskGraph.md

-1
This file was deleted.

docs/agents/AgentTypes/UniversalAgents/universalAgents.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Whenever the user sends any chat in the editor, Universal Agents are called to h
44

55
The Universal Agents performs the following tasks:
66
- Understands the user's message and devises a plan to achieve the user's goal.
7-
- Creates a list of tasks to be performed to achieve the user's goal. In a sense, it generates a DAG (Directed Acyclic Graph) of tasks to be performed. See [Task Graph](./taskGraph.md)
8-
- Matches the tasks with the available agents and picks the best agents to perform those tasks. These could be one or more Agents depending on the Task Graph, and hence generating a DAG of Agents. See [Agent Graph](./agentGraph.md).
7+
- Creates a list of tasks to be performed to achieve the user's goal. In a sense, it generates a DAG (Directed Acyclic Graph) of tasks to be performed.
8+
- Matches the tasks with the available agents and picks the best agents to perform those tasks. These could be one or more Agents depending on the Task Graph, and hence generating a DAG of Agents.
99

1010
## Integrated Universal Agent
1111

docs/user/features/controlK.md

Whitespace-only changes.

docs/user/settings/projectSettings.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Project Setting
2+
3+
The Project Settings module allows you to configure essential project parameters, technical details, secrets, knowledge base, instructions, and usage preferences. Each section within Project Settings serves a unique purpose, providing organized control over the project's configuration.
4+
5+
6+
### App Settings
7+
The App Settings section is where you define key details about your application:
8+
9+
* App Name: The name of your application, displayed in the project dashboard and settings.
10+
* App Unique ID: A unique identifier for the app, used for integration and project management.
11+
* App Description: A short description of the app’s purpose or functionality.
12+
* App GitHub Repo URL: The link to the application's GitHub repository, allowing easy access to the project’s codebase.
13+
14+
![project_app_setting](../../../static/img/project_app_setting.png)
15+
16+
17+
### Technical Info
18+
The Technical Info section provides information about the technology stack used in the project:
19+
20+
* Project Language: Specifies the primary programming language (e.g., JavaScript, Python).
21+
* Project Framework: Defines the main framework used in the project (e.g., React, Express).
22+
* Services: Lists any services integrated within the project, such as databases, APIs, or external tools.
23+
24+
25+
![project_tech_info](../../../static/img/project_tech_info.png)
26+
27+
28+
### Secrets
29+
The Secrets section is used to store and manage sensitive information:
30+
31+
* Add Secret: Allows you to securely add new secrets, such as API keys or passwords.
32+
* List Secrets: Displays a list of all stored secrets for easy access and management
33+
34+
35+
![project_secret](../../../static/img/project_secret.png)
36+
37+
38+
### Knowledge Base
39+
The Knowledge Base section serves as a repository for important information related to the project:
40+
41+
* Add Knowledge Base Entry: Allows you to add entries to the knowledge base with relevant information, documentation, or FAQs.
42+
* List Knowledge Base Entries: Displays all knowledge base entries, with options for editing or deletion.
43+
* Actions: Each entry has actions available for updates or adjustments.
44+
45+
![project_knowledgebase](../../../static/img/project_knowledgebase.png)
46+
47+
### Instruction
48+
There are two ways to add instructions in this section:
49+
50+
* Text Instruction: Use this option to add written instructions directly in text format.
51+
52+
* Local File Instruction: Allows you to upload instructions in the form of files from your local system.
53+
54+
![project_instruction](../../../static/img/project_instruction.png)
55+
56+
57+
### Usage Settings
58+
59+
The Usage section offers various settings to define how the application is used and configured. It includes the following sub-sections:
60+
61+
**Develop Settings**
62+
* Add Agent: Enables adding new development agents to assist with various tasks.
63+
* Layout Settings: Customize the layout and organization of the project environment.
64+
* Run Command: Define commands used to run or test the application in development mode.
65+
66+
![project_develop](../../../static/img/project_develop.png)
67+
68+
69+
**Install Settings**
70+
* Install Custom Agent: Allows installation of custom agents designed for specific tasks or integrations within the project.
71+
72+
![project_install](../../../static/img/project_install.png)
73+
74+
75+
**App Use Settings**
76+
* Customize how the app is used, with options to manage user roles, permissions, or usage guidelines specific to the application.
77+
78+
![project_appuse](../../../static/img/project_appuse.png)

docs/user/template.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,17 @@
1-
# Template
1+
# Template
2+
3+
The Template is designed to facilitate the quick creation of new projects with predefined setups for popular JavaScript frameworks and libraries. By using templates, developers can skip the repetitive tasks involved in setting up project configurations and can jumpstart their work with an organized structure. The available templates include setups for React, Express, Next.js, and an Empty project option.
4+
5+
![get started](../../static/img/template.png)
6+
7+
8+
### Template Options
9+
* React: Sets up a new React app with ES6+, JSX, and Webpack or Vite. Essential dependencies and folder structure are pre-configured. Start quickly by selecting the React template.
10+
11+
* Express: Creates a back-end Express project for RESTful APIs, with basic middleware and error handling. Provides a suitable structure for server-side development; select Express to get started.
12+
13+
* Next.js: Initializes a Next.js app with routing, page, and API setup. Perfect for full-stack development; choose Next.js to begin.
14+
15+
* Empty: A minimal template with only essential files. Ideal for custom setups; use Empty to create a basic project foundation.
16+
17+
**Each template is selectable for quick project setup!**
79.3 KB
Loading

static/img/git.png

-12.3 KB
Loading

static/img/git_old.png

79.5 KB
Loading

static/img/project_app_setting.png

67.9 KB
Loading

static/img/project_appuse.png

85.3 KB
Loading

static/img/project_develop.png

79.3 KB
Loading

static/img/project_install.png

73.3 KB
Loading

static/img/project_instruction.png

65.5 KB
Loading

static/img/project_knowledgebase.png

81.8 KB
Loading

static/img/project_secret.png

59.7 KB
Loading

static/img/project_tech_info.png

70.3 KB
Loading

static/img/template.png

217 KB
Loading

0 commit comments

Comments
 (0)