montevideo-tech / hybrid-meetup-platform

Summer Camp WebRTC challenge. This project can be used to host and run hybrid meetups for the video community. Built by video-dev for video-devs 💚
Apache License 2.0
5 stars 2 forks source link

Create technical onboarding documentation for new team members joining in May. #200

Open felipeYoungi opened 1 year ago

felipeYoungi commented 1 year ago

As new team members are joining in May, we need to create technical onboarding documentation to help them quickly get up to speed on our project. The documentation must be strictly technical in nature, but should be written in a laid back, approachable tone. The documentation should cover the following areas:

1.How to run the project: The documentation should include step-by-step instructions on how to set up the project locally, including any dependencies that need to be installed, configuration details, and how to run the project.

2.Multiple WebRTC providers: Our project intends to use multiple WebRTC providers. The documentation should explain why we have chosen to do so and provide guidance on how to use them effectively.

3.Backend overview: The documentation should provide an overview of the backend architecture and how it fits into the overall project. It should cover the various components of the backend and their responsibilities.

The onboarding documentation is critical to ensure that our new team members are quickly onboarded and can start contributing to the project. Please ensure that the documentation is complete, accurate, and up-to-date.

JonaQuaLabs commented 1 year ago

@youngfelipe1 Part 3, which is related to the backend, is finished: Supabase, Realtime, Backend, and Chat. The first two points would still be missing.

felipeYoungi commented 1 year ago

https://docs.google.com/document/d/1xAtQFdGuxCulLFVWubGiTnqwpwXmdHmXZupWRrKS2AI/edit?usp=sharing