Skip to content

Commit 3f0ff91

Browse files
committed
improvements
1 parent 0006432 commit 3f0ff91

File tree

8 files changed

+32
-13
lines changed

8 files changed

+32
-13
lines changed

augmentos_cloud/packages/sdk/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,13 @@ Download AugmentOS from [AugmentOS.org/install](https://AugmentOS.org/install)
1616
2. Create an ngrok account
1717
3. [Set up a static address/URL in the ngrok dashboard](https://dashboard.ngrok.com/)
1818

19+
* Make sure you run the `ngrok config add-authtoken <your_authtoken>` line.
20+
* Make sure you select `Static Domain`, then generate a static domain.
21+
22+
<center>
23+
<img width="75%" src="https://docs.augmentos.org/img/ngrok_guide_1.png"></img>
24+
</center>
25+
1926
### Register your app with AugmentOS
2027

2128
![AugmentOS Console](https://github.com/user-attachments/assets/36192c2b-e1ba-423b-90de-47ff8cd91318)

augmentos_docs/docs/core-concepts.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Core Concepts
1+
# 🚧 Core Concepts
22

33
*Last updated: March 31, 2025*
44

augmentos_docs/docs/getting-started.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 3
33
---
44

5-
# Getting Started (From Scratch)
5+
# 🚧 Build From Scratch
66

77
*Last updated: March 31, 2025*
88

@@ -179,6 +179,13 @@ To make your locally running app accessible from the internet:
179179
2. Create an ngrok account
180180
3. [Set up a static address/URL in the ngrok dashboard](https://dashboard.ngrok.com/)
181181

182+
* Make sure you run the `ngrok config add-authtoken <your_authtoken>` line.
183+
* Make sure you select `Static Domain`, then generate a static domain.
184+
185+
<center>
186+
<img width="75%" src="/img/ngrok_guide_1.png"></img>
187+
</center>
188+
182189
### 10. Register Your App
183190

184191
![AugmentOS Console](https://github.com/user-attachments/assets/36192c2b-e1ba-423b-90de-47ff8cd91318)
@@ -195,11 +202,9 @@ Edit your `index.ts` to match the app you registered:
195202

196203
```typescript
197204
const server = new MyAugmentOSApp({
198-
packageName: "com.example.myfirstapp", // Must match what you registered
205+
packageName: "com.example.myfirstapp", // Must match your packageName in console.AugmentOS.org
199206
apiKey: 'your_api_key', // Get this from console.AugmentOS.org
200207
port: 3000, // The port your server runs on
201-
augmentOSWebsocketUrl: `ws://cloud.augmentos.org/tpa-ws`, // Connects to AugmentOS Cloud
202-
webhookPath: '/webhook', // The path your server will listen on
203208
});
204209
```
205210

@@ -222,7 +227,7 @@ ngrok http --url=<YOUR_NGROK_URL_HERE> 3000
222227
Congratulations! You've built your first AugmentOS app. To continue your journey:
223228

224229
### Learn More
225-
- Explore [Core Concepts](core-concepts) to understand sessions, events, and the app lifecycle
230+
- Explore [🚧 Core Concepts](core-concepts) to understand sessions, events, and the app lifecycle
226231
- Dive into [Events](events) to handle user interactions and sensor data
227232
- Master [Layouts](layouts) to create rich visual experiences on smart glasses
228233

augmentos_docs/docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: index
3-
title: Intro
3+
title: 👋 Intro
44
slug: /
55
---
66

augmentos_docs/docs/quickstart.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 2
33
---
44

5-
# Quickstart - Build AugmentOS Smart Glasses Apps
5+
# ✅ Quickstart
66

77
*Last updated: March 31, 2025*
88

@@ -30,6 +30,13 @@ Download AugmentOS from [AugmentOS.org/install](https://AugmentOS.org/install)
3030
2. Create an ngrok account
3131
3. [Set up a static address/URL in the ngrok dashboard](https://dashboard.ngrok.com/)
3232

33+
* Make sure you run the `ngrok config add-authtoken <your_authtoken>` line.
34+
* Make sure you select `Static Domain`, then generate a static domain.
35+
36+
<center>
37+
<img width="75%" src="/img/ngrok_guide_1.png"></img>
38+
</center>
39+
3340
### Register your app with AugmentOS
3441

3542
![AugmentOS Console](https://github.com/user-attachments/assets/36192c2b-e1ba-423b-90de-47ff8cd91318)
@@ -74,6 +81,6 @@ For more information, visit the [AugmentOS-Cloud-Example-App repository](https:/
7481

7582
## Next Steps
7683

77-
- Explore the [Getting Started (From Scratch)](getting-started) guide for a more detailed walkthrough
78-
- Learn about [Core Concepts](core-concepts) to understand how AugmentOS apps work
84+
- Explore the [🚧 Build From Scratch](getting-started) guide for a more detailed walkthrough
85+
- Learn about [🚧 Core Concepts](core-concepts) to understand how AugmentOS apps work
7986
- Join our [Discord community](https://discord.gg/5ukNvkEAqT) for help and support

augmentos_docs/docusaurus.config.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ const config: Config = {
8989
to: '/quickstart',
9090
},
9191
{
92-
label: 'Getting Started (From Scratch)',
92+
label: '🚧 Build From Scratch',
9393
to: '/getting-started',
9494
},
9595
],

augmentos_docs/sidebars.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ const sidebars: SidebarsConfig = {
2020
{
2121
type: 'doc',
2222
id: 'getting-started',
23-
label: 'Getting Started (From Scratch)',
23+
label: '🚧 Build From Scratch',
2424
},
2525
{
2626
type: 'category',
27-
label: 'Core Concepts',
27+
label: '🚧 Core Concepts',
2828
link: {
2929
type: 'doc',
3030
id: 'core-concepts',
168 KB
Loading

0 commit comments

Comments
 (0)