Updated styling + added obc build instructions

Author: Adityya-K

docs/astro.config.mjs

@@ -8,6 +8,13 @@ export default defineConfig({
   base: 'OBC-firmware',
 	integrations: [
 		starlight({
+      customCss: [
+        './src/styles/custom.css',
+      ],
+      expressiveCode: {
+        themes: ['github-light-high-contrast', 'tokyo-night'],
+        removeUnusedThemes: true,
+      },
 			title: 'UW Orbital',
 			social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/UWOrbital/OBC-firmware' }],
 			sidebar: [

docs/package-lock.json

@@ -14,4 +14,4 @@
     "astro": "^5.6.1",
     "sharp": "^0.34.2"
   }
-}
+}

docs/package.json

@@ -0,0 +1,44 @@
+---
+title: Building for the OBC
+description: On how to build for the board
+---
+The following is a simple guide for building the app for the OBC and flashing.
+
+## Compiling for the OBC
+1. From the root directory you can run the following commands
+    ```shell
+    mkdir -p build_arm && cd build_arm
+    cmake .. -DCMAKE_BUILD_TYPE=OBC
+    cmake --build .
+    ```
+
+    :::tip[Tip: Reducing Build Time]{icon="setting"}
+    The `cmake --build .` takes some time to run since it is using a single thread to compile. To speed up the process we can use one of the following commands
+    1. `make -j 16` (Recommended for most systems)
+    2. `make -j 32` (This is faster but depends on if your system can handle 32 parallel jobs)
+    :::
+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/).
+
+    :::caution
+    Make sure to specify the `-DBOARD_TYPE=` option to avoid any unwanted behavior
+    :::
+
+## Flashing to the OBC
+There are two main ways to flash to the OBC: **using the bootloader** or **using UniFlash**. UniFlash is the more common way so let's go over that first.
+
+### Flashing Via UniFlash
+1. When you open UniFlash you should be greeted with the following screen...
+
+    ![UniFlash on startup](../../../assets/docs_images/uniflash.png)
+2. For the chip select `RM46L852` if you are using OBC Revision 1 or OBC Revision 2. If you are using the Launchpad, seletc `LAUNCHXL2-RM46`.
+3. Then for the connection, choose `Texas Instruments XDS110 USB Debug Probe`
+4. Now press `Start` and you should see the following screen.
+
+    ![UniFlash on flash](../../../assets/docs_images/uniflash2.png)
+5. Browse for the file you would like to flash and then press `Load Image`.
+    :::note
+    UniFlash may get stuck sometimes and throw errors. In such cases, navigate to session on the top red bar and start a new session. You will have to reconfigure UniFlash but it should get working again.
+    :::
+### Flashing Via the Bootloader (WIP)
+1. Use UniFlash to flash the `OBC-bl.out` file, ensuring you have built it for the correct board.
+

docs/src/assets/docs_images/uniflash.png

@@ -0,0 +1,77 @@
+---
+title: CMake Options Guide
+description: Some useful options and options that we have defined
+---
+The following is a list of options along with their brief description. The guide is divided into most used and extra for convenience. You can go to the end of this page for examples on how to chain these options together.
+
+:::note
+**Options suffixed with an equal sign should have an argument passed into them.** Options without an equal sign suffix just need to be specified, no arguments needed.
+
+If an argument is marked as **Default**, it will be the default argument that is used if the option is not specified. If there are no arguments marked as default then nothing will happen.
+:::
+
+## Most Used Options
+These are options that you will frequently be using while compiling. **Unless otherwise specified these options are to be use within the `build_arm` directory of the project**
+
+### `-DCMAKE_BUILD_TYPE=` (Can be used in directories other than `build_arm`)
+This specifies what the current build directory is for. You can pass either of the **four** arguments into this command...
+* `OBC`: Used to build for the board (use in the `build_arm` directory)
+* `GS`: Used to build code for the ground station (use in the `build_gs` directory)
+* `Test`: Used to build the testing directory for the interfaces (use in the `build` folder)
+* `Examples`: Used to build examples which are barebone binaries to test certain functionality on the board (use in the `build_examples` directory)
+
+### `-DBOARD_TYPE=`
+This option specifies the board that the binary is being built for since different board files will require different HAL (Hardware Abstraction Layer) files to be sourced. You can pass either of the **three** arguments...
+* **Default** `RM46_LAUNCHPAD`: Build the files for the launchpad board
+* `OBC_REVISION_1`: Build the files for the first revision of the OBC
+* `OBC_REVISION_2`: Build the files for the second revision of the OBC
+
+
+## Extra Options
+
+### `-DDEBUG`
+If specified, this removes all optimization flags to debug. Sometimes optimizations can interfere with critical code but, first check your code's logic before using this option.
+
+### `-DLOG_DEFAULT_LEVEL=`
+Specifies the default level for logs. You can pass any enum in the `obc_logging.h` file to this option.
+
+### `-DENABLE_BL_BYPASS=`
+A boolean (takes a 0 or a 1) that specifies whether the app should bypass the bootloader (when you want to flash without the bootloader) to load the app. The boolean values define the following functionality...
+* `0`: The app should not bypass the bootloader and write to the `0x0` address (this is the default address the board looks for to load a program).
+* **Default** `1`: The app should bypass the bootloader and write to `0x0`
+
+### `-DCOMMS_PHY=`
+:::tip[Warning]{icon="seti:html"}
+This option is not fully implemented yet. It's for when comms is complete.
+:::
+
+### `-DOBC_UART_BAUD_RATE=`
+This option helps set the baud rate for the board.
+:::caution
+When using this option, you have to change the baud rate in the HAL using **`HALCOGen`**
+:::
+You can pass any **valid integer baud rate** into this option.
+
+### `-DENABLE_TASK_STATS_COLLECTOR`
+This option enables or disables the task stats collector (statistics on how much memory/cpu each task is using sent via logs). This is a boolean option with each argument defining the functionality...
+* `0`: The app should not send task statistics via logs
+* **Default** `1`: The app should send task statistics via logs
+
+### `-DCMAKE_EXPORT_COMPILE_COMMANDS=ON`
+This is a useful option for IDEs like `neovim` that use Language Servers that require a `compile_commands.json` file. If specified this command will generate a `compile_commands.json` file, else it will not.
+:::tip
+By default cmake will generate this file in the directory you use the `cmake ..` command in. You may have to create a symbolic link to a `compile_commands.json` file in your root directory.
+:::
+
+## Examples
+The following are some examples that might be useful in understanding how to define these options.
+
+1. Say you wanted to build for the 1st revision of the obc and wanted to use the bootloader.
+    ```shell
+    cmake .. -DCMAKE_BUILD_TYPE=OBC -DBOARD_TYPE=OBC_REVISION_1 -DENABLE_BL_BYPASS=0
+    ```
+
+2. Say you wanted to build for the 2nd revision of the obc and wanted to output compile commands as well.
+    ```shell
+    cmake .. -DCMAKE_BUILD_TYPE=OBC -DBOARD_TYPE=OBC_REVISION_2 -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
+    ```