Skip to content

Commit df774d0

Browse files
committed
Finished the getting started page
1 parent a137269 commit df774d0

File tree

2 files changed

+32
-4
lines changed

2 files changed

+32
-4
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The following is a simple guide for building the app for the OBC and flashing.
2525
1. `make -j 16` (Recommended for most systems)
2626
2. `make -j 32` (This is faster but depends on if your system can handle 32 parallel jobs)
2727
:::
28-
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/getting-started/cmake-options/).
28+
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/).
2929

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

docs/src/content/docs/getting-started/index.mdx

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,36 @@ title: Getting started
33
description: Welcome to the Orbital Docs
44
sidebar:
55
badge:
6-
text: WIP
7-
variant: caution
6+
text: New
7+
variant: success
88
order: 1
99
---
10-
Welcome to the Orbital Docs!
10+
import { LinkCard } from '@astrojs/starlight/components';
11+
12+
Welcome to the Orbital Docs! Here you will find all codebase-related documentation.
13+
14+
:::caution
15+
These docs are a work in-progress. As such not everything may be documented. If you need something and you do not find it in the documentation, be sure to mention it on our Discord server so that it can be added!
16+
:::
17+
18+
## About the team
19+
> UW Orbital is a student design team at the University of Waterloo participating in the Canadian Satellite Design Challenge (CSDC) - a competition that involves a dozen universities from across Canada and runs every two years. Teams design a 3U CubeSats with unique missions and payloads, and attempt to pass launch readiness evaluations such as vibration testing. The competition offers to fund the launch costs for the winning team.
20+
21+
**You can find out more on our site:** [https://www.uworbital.com/](https://www.uworbital.com/)
22+
23+
## What software does
24+
Software is a sub-team consisting of two major code projects: the ground station and the satellite.
25+
26+
Ground station related code includes coding front-ends that operators can interact with as well as code that interfaces with the satellite. The ground station mostly consists of Python and React.
27+
28+
The satellite related code includes coding firmware for our onboard computer (OBC) and electrical systems (e.g. BMS). This is a major portion of the codebase and helps the software team enable the creations from the mechanical and electrical sub-teams.
29+
30+
## Suggested Guides
31+
Don't know where to go first? Try one of the following links!
32+
33+
<LinkCard title="The build guide for firmware" href="/OBC-firmware/builds/build-obc/" />
34+
<LinkCard title="The build guide for ground station" href="/OBC-firmware/builds/build-gs/" />
35+
<LinkCard title="The style guide for the code we write" href="/OBC-firmware/getting-started/style-guide/" />
36+
<LinkCard title="An overview of our codebase's file structure" href="/OBC-firmware/getting-started/file-structure/" />
37+
38+
Happy Coding!

0 commit comments

Comments
 (0)