Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
felipeYoungi opened this issue Apr 20, 2023 · 2 comments
Assignees

Comments

@felipeYoungi
Copy link
Contributor

felipeYoungi commented Apr 20, 2023

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.

@felipeYoungi felipeYoungi moved this to 📋 Backlog in hybrid-meetup-platform Apr 20, 2023
@felipeYoungi felipeYoungi moved this from 📋 Backlog to 🔖 Ready for development in hybrid-meetup-platform Apr 25, 2023
@JonaQuaLabs JonaQuaLabs moved this from 🔖 Ready for development to 🏗 In progress in hybrid-meetup-platform Apr 26, 2023
@JonaQuaLabs
Copy link
Contributor

@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 felipeYoungi moved this from 🏗 In progress to 👀 In review in hybrid-meetup-platform May 3, 2023
@felipeYoungi
Copy link
Contributor Author

@felipeYoungi felipeYoungi moved this from 👀 In review to ✅ Done in hybrid-meetup-platform May 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Archived in project
Development

No branches or pull requests

2 participants