Skip to content

Commit ef4d068

Browse files
authored
Merge branch 'adityya/add-docs' into paul/caching-doc
2 parents 00c45a4 + 0d8da6e commit ef4d068

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,5 +61,11 @@ Make sure you follow the [Initial setup](/OBC-firmware/start-here/initial-setup)
6161

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

64-
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.
64+
7. From the root directory, run the following command to initialize your database with the correct schema:
65+
66+
```shell
67+
alembic upgrade head
68+
```
69+
70+
8. 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.
6571
</Steps>

docs/src/content/docs/start-here/task-workflow.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Task Workflow
2+
title: Task workflow
33
description: How members should get started on their tasks and continue
44
sidebar:
55
order: 5
@@ -21,13 +21,15 @@ The following are the steps members should take when looking for and completing
2121
5. Check if all github CI/CD checks all pass. If not address the errors!
2222

2323
6. Once you have verified that all CI/CD checks pass and have proof read your code you can create a new post in the `#pr` channel on discord. Refer to the example post on how to format your post.
24+
<Steps>
2425
1. Make sure to assign the appropriate tags, `GS Backend`, `GS Frontend` or `Firmware`, to your PR post!
2526
2. Make sure to ping the software leads or project managers to review your PR!
27+
</Steps>
2628

2729
7. Wait for the leads to review and address any comments!
2830

2931
8. Once a lead has approved your PR, you can merge it into the main branch!
3032

3133
</Steps>
3234

33-
Happy Coding!
35+
Happy coding!

0 commit comments

Comments
 (0)