Documentation updates!

[ryansurf]

@K-dash

This PR makes changes to the documentation.

The following changes have been made:

• The addition of the cheet_sheet.md file. This list typical commands that I run on the daily, and may be helpful for someone who is learning Git/the codebase
• The addition of a Discord widget and a widget of the repo in index.md
• Updated project structure in structure,md
• Test doc update, including how to run make test and a screenshot of the coverage report
• Added the new cheet_sheet.md to the mkdocs.yml file

I sent you an invite to be a collaborator, so I think you should be able to merge this PR. Let me know if you have any issues!

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src
__init__.py	0	0	100%
api.py	86	6	93%	30, 48, 70–71, 103–104
art.py	9	3	67%	24–25, 37
cli.py	23	4	83%	34, 50–51, 55
gpt.py	10	6	40%	16–21, 32–45
helper.py	143	52	64%	50, 52, 54, 56, 58, 60, 62, 64, 66, 68, 70, 81, 92–96, 129–137, 149, 162–163, 181–183, 193, 195–196, 218–219, 256–266, 273–281
send_email.py	24	24	0%	5–48
server.py	41	41	0%	5–82
settings.py	22	0	100%
TOTAL	358	136	62%

Tests	Skipped	Failures	Errors	Time
9	0 💤	0 ❌	0 🔥	12.503s ⏱️

[K-dash]

@ryansurf
I have reviewed the changes! Please take a look :)

[K-dash]

With the introduction of Poetry, I think start_venv.sh is no longer being used, so it might be okay to delete it!

[K-dash]

While it's not necessary now, if the number of project files increases in the future, modifying this file could become a hassle. So, ex.g it might be a good idea to add a simple script to pre-commit that automatically retrieves and reflects the directory structure :)

[ryansurf]

With the introduction of Poetry, I think start_venv.sh is no longer being used, so it might be okay to delete it!

Ah, forgot about that. Good call

[ryansurf]

While it's not necessary now, if the number of project files increases in the future, modifying this file could become a hassle. So, ex.g it might be a good idea to add a simple script to pre-commit that automatically retrieves and reflects the directory structure :)

How did I not think of this...good idea. I'll work on getting that going

[K-dash]

Nice!

[ryansurf]

@ryansurf

I have reviewed the changes! Please take a look :)

Thank you! I'll implement the changes you recommended and submit another PR

[K-dash]

Thank you! I'll implement the changes you recommended and submit another PR

You're welcome!

(Please ignore this if you already know 😃)
In the usual review process, you would create a fix commit in the same PR and push it to show that you have addressed the feedback. However, if the fix is expected to take time or can be handled later, the workflow is to create a separate PR.
In this case, I judged that the latter seems applicable, so for now, I will go ahead and merge this PR :)

[ryansurf]

Thank you! I'll implement the changes you recommended and submit another PR

You're welcome!

(Please ignore this if you already know 😃) In the usual review process, you would create a fix commit in the same PR and push it to show that you have addressed the feedback. However, if the fix is expected to take time or can be handled later, the workflow is to create a separate PR. In this case, I judged that the latter seems applicable, so for now, I will go ahead and merge this PR :)

I see, thank you for the merge 😄