Skip to content

Commit f2f9a1e

Browse files
committed
updated
1 parent 28620f9 commit f2f9a1e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+213
-102
lines changed

docs/user/1_index.md

Lines changed: 1 addition & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1 @@
1-
# Overview
2-
3-
### Get Started
4-
5-
Codebolt is a fast, lightweight, and customizable source code editor for Windows and macOS, designed to enhance productivity with intelligent features and extensive language support.
6-
Click on the "Get Started" button. This action initiates the sign-in process, where users are given two options for authentication: Google or GitHub.
7-
<!-- Start your journey with Codebolt by exploring these introductory videos. -->
8-
9-
<!-- [![Watch the video](../../static/img/get_started.png)](../../static/video/onboarding.mp4) -->
10-
11-
<iframe width="100%" height="500" src="https://www.youtube.com/embed/YpZV_AFHsX8?si=oNo5MzqlAPqqgdgu" 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>
12-
13-
After successfully completing the onboarding process, users can sign in to explore the application dashboard. On the dashboard, users can:
14-
15-
* Create new project in the workspace or open the project folder.
16-
* Access recent projects and files for quick continuation of their work.
17-
* Create new workspace, accessible from the top-right of the dashboard..
18-
19-
![dashboard](../../static/img/codebolt_application.png)
20-
21-
### Latest Agents
22-
23-
Bug hunter agents and documentation agents help you work faster and make the platform more powerful.
24-
25-
![latest agents](../../static/img/latest_agent.png)
26-
27-
### First Steps
28-
29-
To get started with CodeBolt, here are some initial steps to familiarize yourself with the editor:
30-
31-
* [Intro Videos](#) - Begin your journey with CodeBolt through introductory videos that showcase its features and capabilities.
32-
33-
* [Setup](#) - Install CodeBolt for your platform and configure the toolset according to your development needs.
34-
35-
* [User Interface](#) - Introduction to the basic UI, commands, and features of the codebolt editor.
36-
37-
* [Settings](#) - Customize Codebolt for how you like to work.
38-
39-
* [Chat Features](#) - Explore CodeBolt's built-in chat functionality to communicate seamlessly with collaborators.
40-
41-
* [Preview](#) - Utilize the preview feature in CodeBolt to see real-time updates of your code or project output.
42-
43-
* [Terminal](#) - Access and use the integrated terminal in CodeBolt for command-line operations without leaving the editor.
44-
45-
* [Editor](#) - Learn about the powerful editing capabilities of CodeBolt, including syntax highlighting, auto-completion, and more.
46-
47-
* [Browser](#) - Use CodeBolt's built-in browser to test and preview web applications directly within the editor environment.
48-
49-
* [Planner](#) - Organize your tasks and projects effectively with CodeBolt's integrated planner or task management tools.
50-
51-
* [Git](#) - Take advantage of Git integration within CodeBolt for version control, branching, committing, and merging code changes.
52-
53-
* [Debug](#) - Set up and debug your applications seamlessly using CodeBolt's debugging tools and features.
54-
55-
![Application Overview](../../static/img/application_features.png)
56-
57-
### Downloads
58-
* [Download Codebolt](https://codebolt.ai/) - Quickly find the appropriate install for your platform (Windows, macOS)
59-
60-
1+
# User Guide

docs/user/application/1_index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Introduction
2+
3+
Codebolt is a code editor enabling developers to build and use adaptable use-case specific AI agent toolkits. This gives more accurate software generation, allowing developers and even end users to customise complex softwares using text prompts.
4+
5+
6+
![introduction](/application/introduction.png)
7+
8+
9+

docs/user/2_onboarding.md renamed to docs/user/application/3_onboarding.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Begin by clicking the **Get Started** button on the home page.
66

7-
![get started](../../static/img/get_started.png)
7+
![get started](../../../static/img/get_started.png)
88

99
### Sign Up
1010

@@ -15,7 +15,7 @@ Here, you will have two options for signing up:
1515
- **Google**
1616
- **GitHub**
1717

18-
![sign up](../../static/img/sing-up.png)
18+
![sign up](../../../static/img/sing-up.png)
1919

2020
### Authentication
2121

@@ -24,13 +24,13 @@ Here, you will have two options for signing up:
2424
- If you are a new user, you will be redirected to the username page.
2525
You need to create and add a username. After adding the username, you can proceed further.
2626

27-
![username](../../static/img/username.png)
27+
![username](../../../static/img/username.png)
2828

2929
- After successful authentication, a message will appear:
3030
_"You have successfully signed in. You can close this Page, Now you can return to the app"_
3131
- Once the authentication process is completed, you can proceed to use the application.
3232

33-
![authentication success](../../static/img/authentication-success.png)
33+
![authentication success](../../../static/img/authentication-success.png)
3434

3535
### First Time Users
3636

@@ -40,7 +40,7 @@ Let's walk through every step
4040

4141
1. **Welcome Screen**: Upon successful authentication, new users will be greeted with a welcome message. This screen serves as an introduction to the onboarding process.
4242

43-
![Onboarding Welcome](../../static/onboarding/1.png)
43+
![Onboarding Welcome](../../../static/onboarding/1.png)
4444

4545
2. **Select Default Provider and Model**: In this step, you will choose your preferred provider from a range of options:
4646

@@ -53,39 +53,39 @@ Let's walk through every step
5353

5454
This selection will determine the default provider for you project(you can change it later).
5555

56-
![Onboarding Provider Selection](../../static/onboarding/2.png)
56+
![Onboarding Provider Selection](../../../static/onboarding/2.png)
5757

5858
Now on the same page select a model provided by list of models from the selected provider
5959
(After entering correct key to provider you will se the list of models)
6060

61-
![Onboarding Model Selection](../../static/onboarding/3.png)
61+
![Onboarding Model Selection](../../../static/onboarding/3.png)
6262

6363
3. **Choose Default Workspace**: Select the default workspace where you'd like your project to be organized and managed.
6464

65-
![Onboarding Welcome](../../static/onboarding/4.png)
65+
![Onboarding Welcome](../../../static/onboarding/4.png)
6666

6767
4. **Create Your First Project**: In this step, you will create your first project. Provide a name for your project and click "Create Project in workspace" to get started.
6868

69-
![Onboarding Project Creation](../../static/onboarding/5.png)
69+
![Onboarding Project Creation](../../../static/onboarding/5.png)
7070

7171
After clicking on "Create Project in workspace" this screen will pop-up
7272

7373
Here we can see [Template](./4_Templates/template.md) and [My Templates](./4_Templates/myTemplates.md) <br/>
7474
Just give a name to you project or you can keep a random name and click "Create Project"
7575

76-
![Onboarding Project Creation](../../static/onboarding/6.png)
76+
![Onboarding Project Creation](../../../static/onboarding/6.png)
7777

7878
5. **Developer Page**: After creating your project, you will be taken to the Developer Page where you can start working on your project.
7979

80-
![ Project Created](../../static/onboarding/7.png)
80+
![ Project Created](../../../static/onboarding/7.png)
8181

8282
6. **Congratulations!** You have successfully created your first project. You can now begin exploring the features and capabilities of the platform to build and publish your applications.
8383

8484
### Returning Users
8585

8686
For users who have previously completed the onboarding process, signing in through the portal will redirect you directly to the main application dashboard.
8787

88-
![Application Dashboard](../../static/img/codebolt_application.png)
88+
![Application Dashboard](../../../static/img/codebolt_application.png)
8989

9090
From here, you can access your existing projects, create new projects, and leverage the full capabilities of the CodeBolt platform to build and publish your applications efficiently.
9191

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
# Overview
2+
3+
Natural language interface for exploring, editing, and managing code with contextual AI assistance in Chat mode
4+
5+
## What is Chat?
6+
Chat is Codebolt AI assistant that lives in your sidebar, letting you interact with your codebase through natural language. You can ask questions, request code edits, get terminal command suggestions, and more - all without switching context.
7+
8+
9+
<video width="800px" height="500px" autoplay controls>
10+
<source src="/application/video/chat.mp4" type="video/mp4" />
11+
Your browser does not support the video tag.
12+
</video>
13+
14+
## Core Capabilities
15+
16+
<div style={{display: 'grid', gridTemplateColumns: 'repeat(2, 1fr)', gap: '20px', margin: '20px 0'}}>
17+
<div style={{border: '1px solid #e1e5e9', borderRadius: '8px', padding: '20px', backgroundColor: '#f8f9fa'}}>
18+
<div style={{fontSize: '24px', marginBottom: '12px'}}>📄</div>
19+
<h3 style={{margin: '0 0 8px 0', fontSize: '18px', fontWeight: '600'}}>Understand Code</h3>
20+
<p style={{margin: '0', color: '#666', fontSize: '14px'}}>Ask questions about unfamiliar code, get explanations, or explore your codebase</p>
21+
</div>
22+
23+
<div style={{border: '1px solid #e1e5e9', borderRadius: '8px', padding: '20px', backgroundColor: '#f8f9fa'}}>
24+
<div style={{fontSize: '24px', marginBottom: '12px'}}>💾</div>
25+
<h3 style={{margin: '0 0 8px 0', fontSize: '18px', fontWeight: '600'}}>Edit Code</h3>
26+
<p style={{margin: '0', color: '#666', fontSize: '14px'}}>Make small tweaks or large multi-file changes without manually navigating files</p>
27+
</div>
28+
29+
<div style={{border: '1px solid #e1e5e9', borderRadius: '8px', padding: '20px', backgroundColor: '#f8f9fa'}}>
30+
<div style={{fontSize: '24px', marginBottom: '12px'}}>⚡</div>
31+
<h3 style={{margin: '0 0 8px 0', fontSize: '18px', fontWeight: '600'}}>Run Commands</h3>
32+
<p style={{margin: '0', color: '#666', fontSize: '14px'}}>Get terminal command suggestions for your specific use case</p>
33+
</div>
34+
35+
<div style={{border: '1px solid #e1e5e9', borderRadius: '8px', padding: '20px', backgroundColor: '#f8f9fa'}}>
36+
<div style={{fontSize: '24px', marginBottom: '12px'}}>∞</div>
37+
<h3 style={{margin: '0 0 8px 0', fontSize: '18px', fontWeight: '600'}}>Automate workflows</h3>
38+
<p style={{margin: '0', color: '#666', fontSize: '14px'}}>Let Codebolt search, reason and execute to automate your workflows</p>
39+
</div>
40+
</div>
41+
42+
## Getting Started
43+
44+
Access Chat in the sidebar with `⌘+L` (Mac) or `Ctrl+I` (Windows/Linux). Type your request in natural language, and the AI will respond accordingly.
45+
46+
## What can I do with Chat?
47+
48+
<div style={{overflow: 'hidden', marginBottom: '8px'}}>
49+
<details>
50+
<summary>
51+
Build Features
52+
</summary>
53+
<div style={{padding: '24px', backgroundColor: '#ffffff', color: '#64748b', lineHeight: '1.6'}}>
54+
<p style={{margin: '0 0 16px 0'}}>
55+
Chat has the ability to learn your codebase and make changes to it on your behalf. This is a powerful way to implement new features, and is the perfect tool for feature requests.
56+
</p>
57+
<p style={{margin: '0 0 16px 0'}}>
58+
Simply explain to the chat, using <strong>Agent mode</strong>, what feature you would like it to implement. Chat will look at your codebase, and any relevant files, and suggest any necessary changes across these fields.
59+
</p>
60+
<p style={{margin: '0'}}>
61+
In addition to code edits, Chat may suggest other changes, like adding new files, or adding packages with a package manager.
62+
</p>
63+
</div>
64+
</details>
65+
</div>
66+
67+
<div style={{overflow: 'hidden', marginBottom: '8px', backgroundColor: '#ffffff',}}>
68+
<details>
69+
<summary>
70+
Refactor code
71+
</summary>
72+
<div style={{padding: '24px', backgroundColor: '#ffffff', color: '#64748b', lineHeight: '1.6'}}>
73+
<p style={{margin: '0 0 16px 0'}}>
74+
Need to clean up messy code or reorganize your project? Codebolt can help make your code better and easier to maintain.
75+
</p>
76+
<p style={{margin: '0'}}>
77+
Just describe what you want to improve, like "Make this code faster" or "Organize these files better." Codebolt will understand your project and make the changes safely.
78+
</p>
79+
</div>
80+
</details>
81+
</div>
82+
83+
<div style={{overflow: 'hidden', marginBottom: '8px', backgroundColor: '#ffffff',}}>
84+
<details>
85+
<summary>
86+
Setup new projects
87+
</summary>
88+
<div style={{padding: '24px', backgroundColor: '#ffffff', color: '#64748b', lineHeight: '1.6'}}>
89+
<p style={{margin: '0 0 16px 0'}}>
90+
Starting a new project from scratch? Codebolt makes it super easy!
91+
</p>
92+
<p style={{margin: '0'}}>
93+
Tell it what kind of app you want to build - like a website, mobile app, or API. Codebolt will create all the folders, install the right tools, and write starter code so you can begin coding right away.
94+
</p>
95+
</div>
96+
</details>
97+
</div>
98+
99+
## Modes
100+
101+
Chat offers different modes optimized for specific tasks:
102+
103+
- **Auto**: Acts as a universal agent—Codebolt will autonomously understand your codebase and make broad, codebase-wide changes as needed.
104+
- **Ask**: Get explanations, answers, and feature planning help from the AI about your codebase.
105+
- **Act**: Make targeted edits using only the specific context you provide.
106+
- **Local Agent**: Create a custom agent tailored to your unique workflows.
107+
108+
109+
## Context
110+
111+
Chat understands your codebase by analyzing:
112+
113+
1. **Open files**: What you're currently viewing
114+
2. **@ Symbol**: Use @ to select specific files, folders, and docs you want to reference
115+
3. **# Symbol**: Used to select a specific agent from the agent marketplace
116+
117+
### Using @ to Select Content
118+
119+
The @ symbol lets you precisely choose what Chat should focus on:
120+
121+
- **@filename.js** - Select a specific file
122+
- **@foldername/** - Include an entire folder
123+
- **@docs/** - Reference documentation files
124+
- **@README.md** - Pick specific documentation
125+
126+
Simply type @ and start typing to see available options. This helps Chat give you more accurate answers by focusing on exactly the code and files you're asking about.
127+
128+
The interface suggests relevant context based on your query, ensuring accurate responses.
129+
130+
## Code Edits
131+
132+
When Chat suggests code changes:
133+
134+
1. **Review**: See the proposed changes in a diff view
135+
2. **Apply**: In Ask mode, explicitly apply changes with the "Apply" button
136+
3. **Accept/Reject**: After changes are made, decide whether to keep or discard them
137+
138+
Codebolt's custom model applies suggested edits to files with thousands of lines in seconds.
139+
140+
## Checkpoints
141+
142+
Sometimes you may want to revert to a previous state of your codebase. Codebolt helps you with this by automatically creating checkpoints of your codebase at each request you make, as well every time the AI makes changes to your codebase.
143+
144+
To revert to a previous state, you can either:
145+
146+
- Click the `Restore Checkpoint` button that appears within the input box of a previous request
147+
- Click the + button that shows at the left of a message in the chat history when hovered
148+
149+
## Model Selection
150+
151+
By default, Codebolt has an 'auto-select' option, which will intelligently select the best premium model for your request. This will always use 1 premium request as is, unless you have certain settings enabled that increase this, like long-context mode.
152+
153+
If you want more granular control over which model is used, you can manually select a model from the model picker.
154+
155+
When using custom modes, you can also select a fixed model for each mode, such as selecting `o1` for a `Planning` mode.
156+
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Agent Mode

docs/user/application/4_chat/3_act.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Act

docs/user/application/4_chat/4_ask.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Ask
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Auto

docs/user/application/4_chat/6_tools.md

Whitespace-only changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/user/module/planner.md renamed to docs/user/application/module/planner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- Track ongoing and completed tasks for better productivity.
77

88

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

1111
**Video Guide**
1212

docs/user/module/preview.md renamed to docs/user/application/module/preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
- The Preview feature allows you to view the real-time output of the code you are working on within the application.
55
- After writing or editing code, you can use the Preview tab to see how your application or script will look or behave when executed.
66

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

99
**Video Guide**
1010

docs/user/module/settings/ApplicationSettings/AgentSteps.md renamed to docs/user/application/module/settings/ApplicationSettings/AgentSteps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Agent Steps feature in Universal Agent allows you to define a sequence of up
88
6. User Questions
99

1010

11-
![Agent Steps](../../../../../static/settings/appSettings/7.png)
11+
![Agent Steps](../../../../../../static/settings/appSettings/7.png)
1212

1313

1414
For each step, you can specify which particular agent should be used. This allows you to customize the workflow and leverage the strengths of different AI models based on the task at hand.

docs/user/module/settings/ApplicationSettings/DefaultSettings.md renamed to docs/user/application/module/settings/ApplicationSettings/DefaultSettings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The Default Provider and model you select during [onboarding](/docs/user/onboarding#first-time-users) you update it here. <br/>
44
Also you can update Embedding provider and model.
55

6-
![Default Settings](../../../../../static/settings/appSettings/1.png)
6+
![Default Settings](../../../../../../static/settings/appSettings/1.png)
77

88

99
### Video Guide

docs/user/module/settings/ApplicationSettings/EnvironmentAndServices.md renamed to docs/user/application/module/settings/ApplicationSettings/EnvironmentAndServices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The **Environment and Services** section allows you to configure and manage the
1616
By providing the necessary connection URLs or configuration details, you can seamlessly integrate these services into your application.
1717

1818

19-
![EnvandServices](../../../../../static/settings/appSettings/8.png)
19+
![EnvandServices](../../../../../../static/settings/appSettings/8.png)
2020

2121
By leveraging the **Environment and Services** section, you can streamline the setup and deployment process for your applications. It provides a centralized location to manage runtime dependencies and external service integrations, making it easier to develop, test, and deploy your applications across different environments.
2222

docs/user/module/settings/ApplicationSettings/LLMs.md renamed to docs/user/application/module/settings/ApplicationSettings/LLMs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
- In the **LLMs** section, you can add more LLM providers such as Anthropic and LM Studio.
33
- After adding providers, you can select your preferred provider in the **Default Settings** section.
44

5-
![Default Settings](../../../../../static/settings/appSettings/2.png)
5+
![Default Settings](../../../../../../static/settings/appSettings/2.png)
66

77
- Make sure to update your settings after adding a new provider.
88

docs/user/module/settings/ApplicationSettings/UniversalAgent.md renamed to docs/user/application/module/settings/ApplicationSettings/UniversalAgent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
- Enable custom Universal Agent
44
- Use offline Universal Agent
55

6-
![UniversalAgent](../../../../../static/settings/appSettings/4.png)
6+
![UniversalAgent](../../../../../../static/settings/appSettings/4.png)
77

88
## Enable Custom Universal Agent
99

0 commit comments

Comments
 (0)