Skip to content

Commit 34ac578

Browse files
committed
fix(onboarding): improve onboarding instructions
1 parent 7b6945b commit 34ac578

File tree

1 file changed

+58
-38
lines changed

1 file changed

+58
-38
lines changed

docs/hackathon/0-onboarding.mdx

Lines changed: 58 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,34 @@ import CreateKey from "/static/img/verifiable-ai-hackathon/create-key.png";
1616

1717
# Onboarding
1818

19-
Welcome to the **Verifiable AI Hackathon**!
20-
This guide will walk you through setting up your development environment, including Google Cloud infrastructure, API credentials, and gcloud CLI access.
19+
Welcome to the **Verifiable AI Hackathon**! 🎉
20+
21+
This guide walks you through the **four-step setup** to ensure you have the necessary access and tools to start building.
2122

2223
## Before You Begin
2324

24-
- **Time Estimate:** 15-20 minutes to complete the entire setup
25-
- **Support Channel:** [Telegram Support Group](https://t.me/+StI5VEIvtIg2ODlh)
25+
- **Estimated Time:** ~15-20 minutes
26+
- **Need Help?** Join our [Telegram Support Group](https://t.me/+StI5VEIvtIg2ODlh)
2627

27-
## Step 1: Google Account Setup
28+
## Step 1: Set up your Google account
2829

2930
### Prerequisites
3031

31-
- A Google account (existing or newly created)
32-
- This account will be your primary access point for all hackathon resources
32+
- A Google account (existing or newly created) - this will be your access point for all hackathon resources
3333

34-
### Registration Process
34+
### Registration & access
3535

3636
1. Submit your Google account email during hackathon registration (i.e. the Google Form you submitted)
37-
2. Access to the `verifiable-ai-hackathon` Google Cloud project will be granted on **March 6th** (one day before the hackathon)
38-
3. Verify your access by visiting the [Google Cloud Console](https://console.cloud.google.com/welcome?project=verifiable-ai-hackathon)
39-
4. When access is granted, you'll see this confirmation screen:
37+
2. Access to the `verifiable-ai-hackathon` Google Cloud project will be granted on **March 6th** (i.e. one day before the hackathon)
38+
3. Verify your access by visiting the [Google Cloud Console](https://console.cloud.google.com/welcome?project=verifiable-ai-hackathon), when access is granted you will see the following confirmation:
4039

4140
<img src={AccessGranted} style={{ width: 600 }} />
4241

43-
## Step 2: API Credential Setup
42+
## Step 2: Set up API credentials
4443

4544
### Gemini API Keys
4645

47-
1. Log into your registered Google account after you receive the approval
46+
1. Log into your registered Google account after you receive access to the `verifiable-ai-hackathon` Google Cloud project
4847
2. Visit the [Get a Gemini API key](https://aistudio.google.com/app/apikey) page
4948
3. Click on **Create API key** and select `verifiable-ai-hackathon` from the dropdown
5049

@@ -54,48 +53,61 @@ This guide will walk you through setting up your development environment, includ
5453

5554
<img src={CreateKey} style={{ width: 600 }} />
5655

57-
5. Store your API key securely
56+
5. **Store your API key securely**
5857

59-
### OpenRouter API Keys (Consensus Learning Track Only)
58+
<details>
59+
<summary>OpenRouter API Keys (Consensus Learning Track Only)</summary>
6060

6161
If you're participating in the Consensus Learning track:
6262

6363
1. Visit [OpenRouter](https://openrouter.ai) and create a free account
64-
2. Navigate to the [Settings page](https://openrouter.ai/settings/keys) to generate your API keys
64+
2. Navigate to the [Settings page](https://openrouter.ai/settings/keys) to generate your free API keys
6565
3. **Need higher limits?** Contact the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh) with your team and VM instance name
6666

67-
## Step 3: Set up gcloud CLI
67+
</details>
68+
69+
## Step 3: Install & configure gcloud CLI
6870

69-
1. **Download & install the gcloud CLI**
71+
### Install gcloud CLI
7072

71-
- Follow the [gcloud CLI installation guide](https://cloud.google.com/sdk/docs/install) steps for your OS
72-
- Installation packages available for Windows, macOS, and Linux
73+
1. Follow the [gcloud CLI installation guide](https://cloud.google.com/sdk/docs/install) for Windows, macOS, or Linux.
7374

74-
2. **Verify installation:**
75+
2. **Check installation:**
7576

7677
```bash
7778
gcloud version
7879
```
7980

80-
3. **Authenticate your CLI**
81+
### Authenticate & verify access
8182

82-
Use the same account used for hackathon registration
83+
1. **Authenticate your CLI**
84+
85+
Authenticate using the same Google account used for hackathon registration:
8386

8487
```bash
8588
gcloud auth login
8689
```
8790

88-
4. **Verify project access:**
91+
2. **Verify project access:**
8992

9093
```bash
9194
gcloud projects list
9295
```
9396

9497
The output should include `verifiable-ai-hackathon`
9598

96-
## Step 4: Track template selection
99+
## Step 4: Select your track template
100+
101+
### Prerequisites
102+
103+
Ensure you have the following tools installed:
97104

98-
1. Jump-start your development with one of these pre-configured templates:
105+
- [git](https://git-scm.com/downloads)
106+
- [uv](https://docs.astral.sh/uv/getting-started/installation/) (Python dependency management)
107+
- [Docker](https://www.docker.com) (for containerization)
108+
- [npm](https://nodejs.org/en/download) (for Social AI Agents & AI x DeFi tracks only)
109+
110+
### Choose your template
99111

100112
| Track | Template Repository |
101113
| ------------------ | ------------------------------------------------------------------------------------------- |
@@ -104,20 +116,30 @@ If you're participating in the Consensus Learning track:
104116
| AI x DeFi (DeFAI) | [`flare-foundation/flare-ai-defai`](https://github.com/flare-foundation/flare-ai-defai) |
105117
| Consensus Learning | [`flare-research/flare-ai-consensus`](https://github.com/flare-research/flare-ai-consensus) |
106118

107-
2. Navigate to the template, and click on **Use this template** and **Create a new repository**
119+
### Clone & start building
120+
121+
1. Navigate to the template, and click on **Use this template****Create a new repository**
108122

109123
<img src={ChooseTemplate} style={{ width: 300 }} />
110124

111-
3. **Clone the repo:**
125+
2. **Clone the repo:**
112126

113127
```bash
114128
git clone https://github.com/YOUR_REPO
115129
cd YOUR_REPO
116130
```
117131

118-
4. Follow the **README** in your chosen template for track-specific setup instructions
132+
3. Follow the **README** in your chosen template for track-specific setup instructions
119133

120-
Happy hacking!
134+
**Happy building!**
135+
136+
:::danger[Using hackathon compute resources]
137+
138+
VM instances in `verifiable-ai-hackathon` are continuously monitored.
139+
140+
**Any attempt** to use compute resources for activities outside the hackathon will result in immediate instance termination and possible suspension or permanent ban of account access privileges.
141+
142+
:::
121143

122144
## Troubleshooting
123145

@@ -129,20 +151,18 @@ Happy hacking!
129151

130152
- **gcloud CLI Authentication Problems:**
131153

132-
- Run gcloud auth login --no-launch-browser if the browser auth flow fails
154+
- Run `gcloud auth login --no-launch-browser` if the browser auth flow fails
133155
- Check if you have multiple Google accounts in your browser and select the correct one
134156

135157
- **Windows-specific gcloud issues**
136158
- On Windows, when installing the gcloud CLI, gcloud installs its own basic shell as well.
137159
- We recommend using [git BASH](https://gitforwindows.org) for access to a full set of linux commands.
138160

139-
:::tip[Still not able to bugfix?]
161+
## Need Help?
140162

141-
If you are unable to fix your issue, feel free to reach out to the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh) for support. When reaching out, include:
163+
If you're stuck, reach out to the Flare team on [Telegram](https://t.me/+StI5VEIvtIg2ODlh). Include:
142164

143-
- Your team name
144-
- VM instance name
145-
- Screenshots of any error messages
165+
- Your **team name**
166+
- Your **VM instance name**
167+
- Screenshots of errors
146168
- Steps you've already attempted
147-
148-
:::

0 commit comments

Comments
 (0)