Skip to content

Commit 6f75f5a

Browse files
committed
add overview
1 parent 2d18deb commit 6f75f5a

10 files changed

+104
-19
lines changed

docs/user/1_index.md

+6-19
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,10 @@
11
# Overview
22

3-
**Codebolt** is a Code Editor, with focus on AI Agents. It allows for software developers to use AI Agents for multiple things from code generation to testing, depoloyment and documentation. The Codebolt Agents are the building blocks of the Codebolt Platform.
3+
### Get Started
44

5+
Codebolt is a lightweight yet powerful source code editor designed for your desktop, available on Windows and macOS.
6+
<!-- Start your journey with Codebolt by exploring these introductory videos. -->
7+
8+
9+
![get started](../../static/img/codebolt_application.png)
510

6-
## Codebolt Agents
7-
Codebolt Agents are
8-
<!-- - completion,
9-
- generation,
10-
- review,
11-
- analysis,
12-
- refactoring,
13-
- testing,
14-
- debugging,
15-
- profiling,
16-
- optimization,
17-
- security,
18-
- monitoring,
19-
- deployment,
20-
- integration,
21-
- collaboration,
22-
- documentation,
23-
- visualization, etc. -->

docs/user/2_onboarding.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Onboarding

docs/user/registry/1_index.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Overview
2+
3+
### Getting Started
4+
To begin the onboarding process, users need to click on the "Get Started" button. This action initiates the sign-in process, Upon successful authentication, they will be redirected to the Codebolt portal.
5+
6+
### Exploring the Registry
7+
Once logged in, users will land on the Codebolt home page. The registry provides an overview of Add agents, exploring latest agents, download the codebolt application:
8+
9+
10+
![codebolt registry dashboard](../../../static/img/codebolt_registry_dashboard.png)
11+
12+
### Explore Latest Agents:
13+
14+
Bug hunter agents, Documentation agents ,Enhance your productivity with specialized agents designed to streamline your workflow and expand the platform's capabilities.
15+
16+
![latest agents](../../../static/img/latest_agents.png)
17+
18+
19+
20+
### My Agents:
21+
22+
users can exlpore all the agents they have created or are currently using. It allows users to manage their agents, including updating, modifying, or deploying them as needed. Additionally, users can explore and add new agents.
23+
24+
![latest agents](../../../static/img/my_agents.png)
25+
26+
### Download the Application:
27+
28+
[Download](https://codebolt.ai/) User can download the application for windows and mac operating system.
29+
30+
31+
32+
33+
34+
35+
36+
37+
38+
39+
40+
41+
42+
43+
44+
45+
46+
47+
48+
49+
<!-- **Codebolt** is a Code Editor, with focus on AI Agents. It allows for software developers to use AI Agents for multiple things from code generation to testing, depoloyment and documentation. The Codebolt Agents are the building blocks of the Codebolt Platform.
50+
51+
52+
## Codebolt Agents
53+
Codebolt Agents are -->
54+
<!-- - completion,
55+
- generation,
56+
- review,
57+
- analysis,
58+
- refactoring,
59+
- testing,
60+
- debugging,
61+
- profiling,
62+
- optimization,
63+
- security,
64+
- monitoring,
65+
- deployment,
66+
- integration,
67+
- collaboration,
68+
- documentation,
69+
- visualization, etc. -->

docs/user/registry/2_onboarding.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Onboarding is a crucial initial step in familiarizing users with a platform. It involves guiding them through the setup process and helping them understand how to use the platform's features effectively. In the context of our platform, onboarding starts with user authentication.
2+
3+
### Getting Started
4+
To begin the onboarding process, users need to click on the "Get Started" button. This action initiates the sign-in process, where users are given two options for authentication: Google or GitHub.
5+
6+
![codebolt_registry](../../../static/img/codebolt_registry.png)
7+
8+
9+
10+
### Sign-In with Google:
11+
12+
* When selecting Google, users will be redirected to Google's login page.
13+
* sers need to enter their Google credentials (email and password).
14+
* Upon successful authentication, they will be redirected to the Codebolt portal.
15+
16+
17+
### Sign-In with GitHub:
18+
19+
* If users opt for GitHub, they will be taken to GitHub's login page.
20+
* Users must provide their GitHub credentials to log in.
21+
* Successful authentication will also redirect users to the Codebolt portal.
22+
23+
24+
25+
### Exploring the Dashboard
26+
Once logged in, users will land on the Codebolt home page. The dashboard provides an overview of Add agents, exploring latest agents, download the codebolt application:
27+
28+
![codebolt registry dashboard](../../../static/img/codebolt_registry_dashboard.png)

static/img/codebolt_application.png

38.1 KB
Loading

static/img/codebolt_registry.png

27.1 KB
Loading
103 KB
Loading

static/img/get_started.png

39.7 KB
Loading

static/img/latest_agents.png

93.1 KB
Loading

static/img/my_agents.png

72.8 KB
Loading

0 commit comments

Comments
 (0)