Skip to content

Commit 680dbca

Browse files
committed
Add gs build guide and create initial setup guide page, other minor fixes
1 parent 5b27483 commit 680dbca

File tree

8 files changed

+61
-26
lines changed

8 files changed

+61
-26
lines changed

docs/astro.config.mjs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,6 @@ export default defineConfig({
6363
label: 'FreeRTOS Tasks',
6464
autogenerate: { directory: 'tasks' },
6565
},
66-
{
67-
label: 'Guides',
68-
autogenerate: { directory: 'guides' },
69-
},
7066
],
7167
}),
7268
],

docs/src/content/docs/builds/build-gs.mdx

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,47 @@ title: Building the ground station
33
description: On how to build for ground station
44
sidebar:
55
badge:
6-
text: WIP
7-
variant: caution
6+
text: New
7+
variant: success
88
order: 2
99
---
10+
import { Steps } from '@astrojs/starlight/components';
11+
1012
The following guide outlines a procedure to build the ground station.
13+
14+
## Compiling for the ground station
15+
From the root directory, run the following commands:
16+
```shell
17+
mkdir -p build_gs && cd build_gs
18+
cmake .. -DCMAKE_BUILD_TYPE=GS
19+
cmake --build .
20+
```
21+
22+
:::tip[Tip: Reducing Build Time]{icon="setting"}
23+
The `cmake --build .` takes some time to run since it is using a single thread to compile. To speed up the process we can replace it with one of the following commands:
24+
1. `make -j 16` (Recommended for most systems)
25+
2. `make -j 32` (This is faster but depends on if your system can handle 32 parallel jobs)
26+
:::
27+
28+
## Setting up frontend development
29+
To run the frontend, Deno 2 must be installed. If it isn't, see [Initial setup](/OBC-firmware/start-here/setup/) and follow it to set up the database as well.
30+
31+
Run all commands from the root directory.
32+
33+
### Installing the frontend
34+
```shell
35+
cd gs/frontend
36+
deno install --frozen
37+
```
38+
### Running the ARO frontend
39+
This will start the frontend at `localhost:5173`.
40+
```shell
41+
cd gs/frontend/aro
42+
deno task dev
43+
```
44+
### Running the MCC frontend
45+
This will start the frontend at `localhost:5173`.
46+
```shell
47+
cd gs/frontend/mcc
48+
deno task dev
49+
```

docs/src/content/docs/builds/build-obc.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,20 @@ The following is a simple guide for building the app for the OBC and flashing.
1010

1111
## Compiling for the OBC
1212
<Steps>
13-
1. From the root directory you can run the following commands
13+
1. Before compiling, ensure that the Python virtual environment is activated. If you do not have this configured, see [Initial setup](/OBC-firmware/start-here/setup/).
14+
2. From the root directory, run the following commands:
1415
```shell
1516
mkdir -p build_arm && cd build_arm
1617
cmake .. -DCMAKE_BUILD_TYPE=OBC
1718
cmake --build .
1819
```
1920

2021
:::tip[Tip: Reducing Build Time]{icon="setting"}
21-
The `cmake --build .` takes some time to run since it is using a single thread to compile. To speed up the process we can replace it with one of the following commands...
22+
The `cmake --build .` takes some time to run since it is using a single thread to compile. To speed up the process we can replace it with one of the following commands:
2223
1. `make -j 16` (Recommended for most systems)
2324
2. `make -j 32` (This is faster but depends on if your system can handle 32 parallel jobs)
2425
:::
25-
2. There are also plenty of extra options that you can use besides `-DCMAKE_BUILD_TYPE` by appending them to the `cmake ..` command. Take a look at the [CMake Options Guide](/OBC-firmware/builds/cmake-options/).
26+
3. There are also plenty of extra options that you can use besides `-DCMAKE_BUILD_TYPE` by appending them to the `cmake ..` command. Take a look at the [CMake options guide](/OBC-firmware/builds/cmake-options/).
2627

2728
:::caution
2829
Make sure to specify the `-DBOARD_TYPE=` option to avoid any unwanted behavior

docs/src/content/docs/comms/adding-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar:
99
---
1010
The following is a guide to adding commands to ensure that they work in the python and c sections of this code base. (To navigate quickly, github provides a table of contents via the little list icon on the README header)
1111

12-
## Adding commands to the C Side
12+
## Adding commands to the C side
1313
### Step 1: Adding the command id
1414
1. Navigate to `obc_gs_command_id.h` and in the `cmd_callback_id_t` enum struct, add your command id. This must be **before** `NUM_CMD_CALLBACKS` (since we use it to count the number of commands throughout the codebase). The command should be written in uppercase with underscores as spaces and should be prefixed with `CMD`. As an example, `CMD_MAPLE_LEAFS` is correct but `CmdMapleLeafs`, `CMDMAPLELEAFS`, `cmd_maple_leafs` are not.
1515
```c

docs/src/content/docs/guides/example.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/src/content/docs/start-here/file-structure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
badge:
66
text: WIP
77
variant: caution
8-
order: 3
8+
order: 4
99
---
1010
import { FileTree } from '@astrojs/starlight/components';
1111

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Initial setup
3+
description: Initial setup for your development workflow
4+
sidebar:
5+
order: 2
6+
badge:
7+
text: WIP
8+
variant: caution
9+
---
10+
11+
This setup guide will guide you through the process of setting up your development environment.
12+
13+
Placeholder

docs/src/content/docs/start-here/style-guide.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,7 @@
22
title: Style guide
33
description: Style guide for all firmware and ground station code
44
sidebar:
5-
badge:
6-
text: New
7-
variant: success
8-
order: 2
5+
order: 3
96
---
107

118
This style guide outlines our team standards for writing firmware and ground station code.

0 commit comments

Comments
 (0)