Skip to content

Commit e25a131

Browse files
committed
onboarding documentation completed
1 parent d5314f3 commit e25a131

File tree

10 files changed

+80
-13
lines changed

10 files changed

+80
-13
lines changed

docs/user/2_onboarding.md

+62-12
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,90 @@
11
# Onboarding
22

3-
### Step 1: Getting Started
3+
### Getting Started
4+
45
Begin by clicking the **Get Started** button on the home page.
56

67
![get started](../../static/img/get_started.png)
78

9+
### Sign Up
810

9-
### Step 2: Sign Up
1011
Once you click **Get Started**, you will be redirected to the portal for **Sign Up**.
1112

12-
1313
Here, you will have two options for signing up:
14+
1415
- **Google**
1516
- **GitHub**
1617

1718
![sign up](../../static/img/sing-up.png)
1819

19-
### Step 3: Authentication
20+
### Authentication
21+
2022
- **If you choose Google or Github**:
2123
- You will be redirected to Google's or Github authentication page for Verification.
2224
- If you are a new user, you will be redirected to the username page.
23-
You need to create and add a username. After adding the username, you can proceed further.
25+
You need to create and add a username. After adding the username, you can proceed further.
2426

2527
![username](../../static/img/username.png)
2628

2729
- After successful authentication, a message will appear:
28-
*"You have successfully signed in. You can close this Page, Now you can return to the app"*
30+
_"You have successfully signed in. You can close this Page, Now you can return to the app"_
2931
- Once the authentication process is completed, you can proceed to use the application.
3032

31-
3233
![authentication success](../../static/img/authentication-success.png)
3334

34-
After successfully completing the onboarding process, users can sign in to explore the application dashboard. On the dashboard, users can:
35+
### First Time Users
36+
37+
After signing in for the first time, you will see an onboarding screen
38+
39+
Let's walk through every step
40+
41+
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.
42+
43+
![Onboarding Welcome](../../static/onboarding/1.png)
44+
45+
2. **Select Default Provider and Model**: In this step, you will choose your preferred provider from a range of options:
46+
47+
- Cloud Providers:
48+
- OpenAI
49+
- Anthropic
50+
- Local Providers:
51+
- LMStudio
52+
- CodeBolt Provider
53+
54+
This selection will determine the default provider for you project(you can change it later).
55+
56+
![Onboarding Provider Selection](../../static/onboarding/2.png)
57+
58+
Now on the same page select a model provided by list of models from the selected provider
59+
(After entering correct key to provider you will se the list of models)
60+
61+
![Onboarding Model Selection](../../static/onboarding/3.png)
62+
63+
3. **Choose Default Workspace**: Select the default workspace where you'd like your project to be organized and managed.
64+
65+
![Onboarding Welcome](../../static/onboarding/4.png)
66+
67+
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.
68+
69+
![Onboarding Project Creation](../../static/onboarding/5.png)
70+
71+
After clicking on "Create Project in workspace" this screen will pop-up
72+
73+
Here we can see [Template](./Templates/template.md) and [My Templates](./Templates/myTemplates.md) <br/>
74+
Just give a name to you project or you can keep a random name and click "Create Project"
75+
76+
![Onboarding Project Creation](../../static/onboarding/6.png)
77+
78+
5. **Developer Page**: After creating your project, you will be taken to the Developer Page where you can start working on your project.
79+
80+
![ Project Created](../../static/onboarding/7.png)
81+
82+
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.
83+
84+
### Returning Users
85+
86+
For users who have previously completed the onboarding process, signing in through the portal will redirect you directly to the main application dashboard.
3587

36-
* Create new project in the workspace or open the project folder.
37-
* Access recent projects and files for quick continuation of their work.
38-
* Create new workspace, accessible from the top-right of the dashboard..
88+
![Application Dashboard](../../static/img/codebolt_application.png)
3989

40-
![dashboard](../../static/img/codebolt_application.png)
90+
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.

docs/user/Templates/myTemplates.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# My 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!**

docs/user/template.md docs/user/Templates/template.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
![get started](../../static/img/template.png)
5+
<!-- ![get started](../../static/img/template.png) -->
66

77

88
### Template Options

static/onboarding/1.png

29.5 KB
Loading

static/onboarding/2.png

81.7 KB
Loading

static/onboarding/3.png

126 KB
Loading

static/onboarding/4.png

43.6 KB
Loading

static/onboarding/5.png

77.4 KB
Loading

static/onboarding/6.png

110 KB
Loading

static/onboarding/7.png

68.6 KB
Loading

0 commit comments

Comments
 (0)