Skip to content

Commit 5d8786f

Browse files
Sachin SridharSachin Sridhar
Sachin Sridhar
authored and
Sachin Sridhar
committed
add page for onboarding to dashboard
1 parent 304a240 commit 5d8786f

File tree

5 files changed

+65
-6
lines changed

5 files changed

+65
-6
lines changed

dashboard.mdx

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: "Dashboard"
3+
sidebarTitle: "Dashboard"
4+
description: "See your app's requests on the Subtrace dashboard"
5+
icon: "table-layout"
6+
---
7+
8+
<Note>
9+
This guide assumes that your app is deployed on a Linux machine. If your app
10+
is running on macOS, see [here](/macos).
11+
</Note>
12+
13+
Here's what you'll see when you log in to the Subtrace
14+
[dashboard](https://subtrace.dev/dashboard) for the first time:
15+
16+
<img className="rounded-xl" src="/images/onboarding-main.png" />
17+
18+
Choose the backend that you're using and follow the instructions to start your
19+
app with Subtrace.
20+
21+
<img
22+
className="rounded-xl max-w-1/2"
23+
style={{ maxWidth: "50%", justifySelf: "center" }}
24+
src="/images/onboarding-steps.png"
25+
/>
26+
27+
Subtrace automatically detects when you've started your app:
28+
29+
<img
30+
className="rounded-xl max-w-1/2"
31+
style={{ maxWidth: "50%", justifySelf: "center" }}
32+
src="/images/onboarding-done.png"
33+
/>
34+
35+
And that's it! You can hit "Finish", and send some requests to your app to see them
36+
show up in realtime.
37+
38+
<AccordionGroup>
39+
<Accordion title="My backend isn't listed here, can I still use Subtrace?">
40+
Absolutely! Subtrace supports every language and framework out of the box.
41+
You can select "Other" as your tech stack in the setup for generic
42+
instructions on how to use Subtrace with any backend.
43+
</Accordion>
44+
45+
<Accordion title={`What happens if I choose "I'll do this later"?`}>
46+
You can still set up your app with Subtrace. Check our guides for your
47+
specific backend.
48+
49+
If you'd like to see the setup instructions again, simply refresh the page.
50+
51+
</Accordion>
52+
<Accordion title="What if Subtrace doesn't detect my app?">
53+
Verify that:
54+
- Your app is running with `./subtrace run -- my-app`
55+
- The `SUBTRACE_TOKEN` env var is set (check with `echo $SUBTRACE_TOKEN`)
56+
- Your app is running on a Linux machine. If you're using macOS, see [here](/macos)
57+
58+
If these don't solve your issue, reach out to [email protected].
59+
We're happy to help!
60+
61+
</Accordion>
62+
63+
</AccordionGroup>

images/onboarding-done.png

115 KB
Loading

images/onboarding-main.png

217 KB
Loading

images/onboarding-steps.png

105 KB
Loading

mint.json

+2-6
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
"navigation": [
4444
{
4545
"group": "Getting Started",
46-
"pages": ["quickstart"]
46+
"pages": ["quickstart", "dashboard"]
4747
},
4848
{
4949
"group": "Guides",
@@ -64,11 +64,7 @@
6464
},
6565
{
6666
"group": "Configuration",
67-
"pages": [
68-
"rules",
69-
"tags",
70-
"credentials"
71-
]
67+
"pages": ["rules", "tags", "credentials"]
7268
},
7369
{
7470
"group": "Tutorials",

0 commit comments

Comments
 (0)