Skip to content

Commit f92b972

Browse files
committed
Minor fixes to various guides
1 parent 803191d commit f92b972

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

docs/src/content/docs/start-here/database-setup.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,14 +52,14 @@ Make sure you follow the [Initial setup](/OBC-firmware/start-here/initial-setup)
5252
# You should be logged into the database
5353
\q # Log out again
5454

55-
5. From the root directory, run the following commands to create a new .env file:
55+
5. From the root directory, run the following commands to create a new `.env` file:
5656

5757
```shell
5858
cd gs/backend/config
5959
cp template.env .env
6060
```
6161

62-
6. Edit the new .env file to add your login details in the quotes. In Linux/WSL, you can use `vim` or `nano`.
62+
6. Edit the `.env` file to add your login details in the quotes. In Linux/WSL, you can use `vim` or `nano`.
6363

6464
7. Ensure that your Python virtual environment is activated. If not, follow [Initial setup](/OBC-firmware/start-here/initial-setup). Start the backend in development mode by running `fastapi dev gs/backend/main.py` from the root directory. This will also initialize the database.
6565
</Steps>

docs/src/content/docs/start-here/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Software is a subteam of Orbital consisting of two major code projects: the grou
2222

2323
Ground station related code includes frontends that operators can interact with as well as software that interfaces with the satellite. The ground station stack is primarily built with Python and React.
2424

25-
The satellite related code includes firmware for the onboard computer (OBC) and electrical systems, such as the BMS (Battery Management System). This is a major part of the codebase and allows the software team support the work of the mechanical and electrical subteams.
25+
The satellite related code includes firmware for the onboard computer (OBC) and electrical systems, such as the BMS (Battery Management System). This is a major part of the codebase and allows the software team to support the work of the mechanical and electrical subteams.
2626

2727
## Suggested guides
2828
Don't know where to go first? Try one of the following links!

docs/src/content/docs/start-here/initial-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ If not, open a terminal and run the following commands to install Git:
7575
pip install -r requirements.txt
7676
pip install -e .
7777

78-
7. Setup the pre-commit by running the following commands in the repository's root directory. You may need to install unzip in order to install Deno. If you do not have unzip, run `sudo apt install unzip`.
78+
7. Setup the pre-commit by running the following commands in the repository's root directory. You may need to install `unzip` in order to install Deno. If you do not have `unzip`, run `sudo apt install unzip`.
7979
8080
```shell
8181
# The first command installs Deno, which is required for our pre-commit

0 commit comments

Comments
 (0)