Skip to content

Commit ad323ed

Browse files
committed
feat: update new docs for smart building
1 parent 738a384 commit ad323ed

12 files changed

Lines changed: 2814 additions & 1444 deletions

package-lock.json

Lines changed: 1894 additions & 208 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
157 KB
Loading
156 KB
Loading
222 KB
Loading
894 KB
Loading
865 KB
Loading
189 KB
Loading

src/content/onboarding/_meta.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
export default {
2+
"fleet-tracking": "Fleet Tracking",
3+
"smart-building": "Smart Building",
4+
}
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
title: Fleet Tracking
3+
---
4+
5+
# Fleet Tracking
6+
7+
---
8+
9+
### Opening Your Space
10+
11+
1. **Open Space URL**: In your workspace, click on your organization's URL slug name
12+
2. **Access Space Site**: The space site will open automatically
13+
3. **Sign In**: Choose "Get Started" to sign up or sign in
14+
- Select **Sign Up** if you don't have an account
15+
- Select **Sign In** if you already have an account
16+
- Use the same email/password or Gmail account from the organization site
17+
<img
18+
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/signin-signup-your-space.gif"
19+
alt="Sign In/Sign Up Your Space"
20+
/>
21+
22+
### Enable Location Services
23+
24+
4. **Allow Location Access**: When prompted, choose "Allow" to enable location-based features and improve your experience
25+
<img
26+
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/allow-location-access.gif "
27+
alt="Allow Location Access"
28+
/>
29+
Lines changed: 52 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
title: Onboarding
2+
asIndexPage: true
3+
sidebarTitle: Installation
34
---
45

5-
import {Cards} from "nextra/components";
6+
7+
import { Cards } from "nextra/components";
8+
import {
9+
RichCardOptions,
10+
RichCardOption,
11+
} from "@/app/_components/RichCard.jsx";
612

713
# Onboarding Guide
814

@@ -16,8 +22,8 @@ To get started, create a free account using your email, name, and password. You
1622
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/signup.png"
1723
alt="Create Account"
1824
/>
19-
This will be for the **Admin** - this login will have permissions to perform operations
20-
in the account.
25+
This will be for the **Admin** - this login will have permissions to perform
26+
operations in the account.
2127

2228
[**Sign up for SpaceDF →**](https://spacedf.com/en/auth/sign-up)
2329

@@ -44,8 +50,9 @@ An organization acts as the main container for your locations, devices, and user
4450
3. **Choose a Template**: Select from SpaceDF's ready-to-use template library
4551
4. **Wait for Setup**: Your organization will be created in a few seconds
4652
<img
47-
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/finish-setup-organization-spacedf-onboarding.gif"
53+
src="/images/onboarding/finish-setup-organization-spacedf-onboarding.gif"
4854
alt="Wait for Setup"
55+
style={{ width: "100%", height: "100%" }}
4956
/>
5057

5158
## 3. Add Devices to Device Hub
@@ -138,37 +145,44 @@ For adding single devices:
138145
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/add-device-manual-spacedf-onboarding.gif"
139146
alt="Add Device"
140147
/>
141-
2. **Fill Device Information**: Enter required fields:
148+
2. **Select Device Model**: Select the device model that matches your hardware to ensure correct setup and data handling.
149+
150+
<img
151+
src="/images/onboarding/select_device_model.gif"
152+
alt="Select device model"
153+
/>
154+
155+
3. **Fill Device Information**: Enter required fields:
142156
- **DevEUI**: Device unique identifier
143157
- **JoinEUI**: Join server identifier
144158
- **App Key**: Application key for authentication
145159
<img
146160
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/fill-require-information-spacedf-onboarding.png"
147161
alt="Fill Device Information"
148162
/>
149-
3. **Enable Public State** (optional): Make device visible to all organization users
163+
4. **Enable Public State** (optional): Make device visible to all organization users
150164
<img
151165
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/public-device.gif"
152166
alt="Enable Public Device Status"
153167
/>
154-
4. **Select Network**: Choose TTN, ChirpStack, or Helium
168+
5. **Select Network**: Choose TTN, ChirpStack, or Helium
155169
<img
156170
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/select-the-network-spacedf-onboarding.png"
157171
alt="Import Device CSV Network"
158172
/>
159-
5. **Complete Setup**: Click Next and wait for device to be added to Inventory
173+
6. **Complete Setup**: Click Next and wait for device to be added to Inventory
160174

161175
### CSV Import for Multiple Devices
162176

163177
For bulk device registration:
164178

165-
1. **Choose Manual Option**: Select device brand and click Next
166-
2. **Click Import CSV**: Upload your prepared CSV file
167-
3. **Download Template** (if needed): Use our pre-formatted CSV template
179+
1. **Choose CSV Import**: Select device brand and continue
180+
2. **Download Template** (if needed): Use our pre-formatted CSV template
168181
<img
169182
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/import-CSV.png"
170183
alt="Import Device CSV"
171184
/>
185+
3. **Upload CSV**: Click **Import CSV** and upload your prepared file
172186
4. **Configure Settings**: Enable Public Device Status if desired
173187
5. **Select Network**: Choose TTN, ChirpStack, or Helium
174188
6. **Import Devices**: Click Next and wait for all devices to be processed
@@ -178,27 +192,36 @@ For bulk device registration:
178192
## 4. Access Your Space
179193

180194
Each organization has its own Space - a dedicated environment for device monitoring and management.
195+
Before you start accessing your Space, we recommend taking a quick look at what Space and Digital Twin are. This will help you understand and move through the next steps more smoothly.
181196

182-
### Opening Your Space
197+
👉 **Learn more**: [What is a Space? · What is a Digital Twin?](/docs/spaces)
183198

184-
1. **Open Space URL**: In your workspace, click on your organization's URL slug name
185-
2. **Access Space Site**: The space site will open automatically
186-
3. **Sign In**: Choose "Get Started" to sign up or sign in
187-
- Select **Sign Up** if you don't have an account
188-
- Select **Sign In** if you already have an account
189-
- Use the same email/password or Gmail account from the organization site
190-
<img
191-
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/signin-signup-your-space.gif"
192-
alt="Sign In/Sign Up Your Space"
193-
/>
199+
SpaceDF offers multiple ready-to-use templates designed for different use cases. Each template comes with its own Space experience and onboarding flow.
200+
Select the template below that matches your setup to continue accessing your Space.
194201

195-
### Enable Location Services
202+
<RichCardOptions>
203+
<RichCardOption
204+
icon={
205+
<div className="w-2/3 text-center">
206+
🚚
207+
</div>
208+
}
209+
title="Fleet Tracking"
210+
description="Track assets and vehicles with real-time location and status monitoring."
211+
href="/docs/onboarding/fleet-tracking"
212+
/>
196213

197-
4. **Allow Location Access**: When prompted, choose "Allow" to enable location-based features and improve your experience
198-
<img
199-
src="https://d33et8skld5wvq.cloudfront.net/images/spacedf-docs/onboarding/allow-location-access.gif "
200-
alt="Allow Location Access"
201-
/>
214+
<RichCardOption
215+
icon={
216+
<div className="w-2/3 text-center">
217+
🏢
218+
</div>
219+
}
220+
title="Smart Building"
221+
description="Monitor buildings, rooms, and sensors with a digital twin experience."
222+
href="/docs/onboarding/smart-building"
223+
/>
224+
</RichCardOptions>
202225

203226
## 5. Add Devices to Your Space
204227

0 commit comments

Comments
 (0)