Skip to content

Commit aa0119b

Browse files
committed
project-settings updates
1 parent 2ddfc5f commit aa0119b

File tree

17 files changed

+118
-4
lines changed

17 files changed

+118
-4
lines changed

docs/user/features/layouts.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Layouts
2+
3+
Codebolt provides three layout options to suit different development needs and preferences:
4+
5+
1. **Basic**: This layout is ideal when you want to focus on updating your app through chat interactions without seeing the code. It provides a streamlined interface for making changes to your app using natural language conversations.
6+
7+
2. **Dev**: The Dev layout is designed for basic development tasks. It includes a chat interface, a code editor, and a preview pane. This layout allows you to have conversations with the AI, make code changes, and see the results in real-time.
8+
9+
3. **Power Dev**: The Power Dev layout is tailored for advanced development scenarios. In addition to the features provided in the Dev layout, it also includes a terminal, console, and debugging tools. This layout gives you full control over your development environment, enabling you to perform complex tasks and troubleshoot issues effectively.
10+
11+
Choose the layout that best fits your development style and requirements. The Basic layout is perfect for quick updates and iterations, while the Dev and Power Dev layouts offer progressively more powerful tools for comprehensive development workflows.
12+
13+
14+
### Video Guide
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# App Settings
2+
3+
Customize the name, description and githubUrl. This information is used when publishing your project.
4+
5+
In the App Settings, you can:
6+
- Change the name of your app
7+
- Give it a unique ID
8+
- Add a description
9+
- Specify the GitHub URL where the application's code repository will be maintained
10+
11+
![AppSettings](../../../../../static/settings/projectSettings/1.png)
12+
13+
### Video Guide
14+
15+
<iframe width="100%" height="315" src="https://www.youtube.com/embed/VOQx8kqKvAE?si=A1Yugc_ub1pOufwv" 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>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Instructions
2+
3+
4+
5+
![Instructions](../../../../../static/settings/projectSettings/5.png)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Knowledge Base
2+
3+
4+
5+
![knowledgebase](../../../../../static/settings/projectSettings/4.png)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Secrets
2+
3+
![AppSettings](../../../../../static/settings/projectSettings/3.png)
4+
5+
Every project needs secrets to store sensitive information like API keys, database passwords, etc. In this section, you can add a list of secrets for your project:
6+
7+
### Creating
8+
9+
1. Click the "Add Secret" button to create a new secret.
10+
2. Provide a name and description for the secret that describes its purpose.
11+
3. Enter the secret value.
12+
4. Click "Save" to store the secret securely.
13+
14+
15+
### Editing
16+
To edit an existing secret:
17+
1. Click the "Edit" button next to the secret you want to modify.
18+
2. Update the secret details as needed.
19+
3. Click "Save" to apply the changes.
20+
21+
### Deleting
22+
23+
To delete a secret:
24+
1. Click the "Delete" button next to the secret you want to remove.
25+
26+
27+
## Video Guide
28+
29+
30+
<iframe width="100%" height="315" src="https://www.youtube.com/embed/97ndwO6Heek?si=I1luQfciotAy5i0O" 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>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Technical Info
2+
3+
4+
5+
![technicalinfo](../../../../../static/settings/projectSettings/5.png)
6+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Usage
2+
3+
![usages](../../../../../static/settings/projectSettings/6.1.png)
4+
5+
Usage settings are divided into three parts:
6+
1. Develop Settings
7+
2. Install Settings
8+
3. App Use Settings
9+
10+
## Develop Settings
11+
![usages](../../../../../static/settings/projectSettings/6.1.png)
12+
The Develop Settings section provides three options:
13+
1. Select Agent: Choose the appropriate agent for your project.
14+
2. Select Layout: Pick from Basic, Developer, or Power Developer layouts based on your needs.
15+
3. Run Command: Specify any commands to run during the development process.
16+
17+
When user publish their projects as app then to develop on top of this this project they need to know what agent will be best suited what are step to run the project.
18+
19+
## Install Settings
20+
![usages](../../../../../static/settings/projectSettings/6.2.png)
21+
The Install Settings section provides instructions and commands to install the app. It includes:
22+
1. Installation Instructions: Step-by-step guide on how to install the app.
23+
2. Installation Command: Specify the command(s) needed to install the app, such as `npm install` or `pip install`.
24+
25+
When a user wants to install and use an app created from this project, they will refer to this section for the necessary installation details and commands.
26+
27+
## App Use Settings
28+
![usages](../../../../../static/settings/projectSettings/6.3.png)
29+
The App Use Settings section provides options for users to configure how to use the app:
30+
1. Select Agent: Choose the appropriate agent for running the app.
31+
2. Select Layout: Pick the layout that is best suited for the app, such as Basic, Dev, or PowerDev.
32+
3. Pre-run Commands: Specify any commands that need to be run before starting the app.
33+
4. App Preview: Select whether to preview the app locally or on the web.
34+
35+
These settings allow users to customize the app's runtime environment, UI layout, initialization steps, and preview mode to best fit their needs when using the app created from this project.
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# Project Setting
1+
# Project Settings
22

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.
3+
In the **Project Settings** section, you can configure various options for your project:
44

5-
6-
### App Settings
5+
1. [App Settings](AppSettings)
6+
2. [Technical Info](TechnicalInfo)
7+
3. [Secrets](Secrets)
8+
4. [Knowledge Base](KnowledgeBase)
9+
5. [Instructions](Instructions)
10+
5. [Usage](Usage)

docs/user/usage.md

Whitespace-only changes.

static/settings/projectSettings/1.png

93.7 KB
Loading

static/settings/projectSettings/2.png

103 KB
Loading

static/settings/projectSettings/3.png

79.8 KB
Loading

static/settings/projectSettings/4.png

104 KB
Loading

static/settings/projectSettings/5.png

82.3 KB
Loading
104 KB
Loading
105 KB
Loading
108 KB
Loading

0 commit comments

Comments
 (0)