Skip to content
New issue

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

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

Already on GitHub? # to your account

In-depth Software Documentation #457

Open
vedarshshah opened this issue Sep 28, 2023 · 1 comment
Open

In-depth Software Documentation #457

vedarshshah opened this issue Sep 28, 2023 · 1 comment
Labels
documentation Related to documentation of robot software.
Milestone

Comments

@vedarshshah
Copy link
Member

Background

Each CS team member possesses in-depth knowledge of certain areas of the software. It is vital for this knowledge to be written down, so it can be passed to the next generation of club leaders. This would also serve as a useful resource for new members joining the club to understand various aspects of our software.

Purpose

Write in-depth documentation on each part of the robot's software. Discuss not just the "what", but also the "why" behind key decisions, tools, frameworks, code, etc.

This is meant to be an ongoing effort through the 2023-24 year.

@vedarshshah vedarshshah added the documentation Related to documentation of robot software. label Sep 28, 2023
@vedarshshah vedarshshah added this to the Spring 2024 milestone Sep 28, 2023
@ShaanGondalia
Copy link
Contributor

Would recommend re-recording the software overview video on youtube as well. Its a good resource for people who want a high level understanding of the tech stack and how components work together.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Related to documentation of robot software.
Projects
None yet
Development

No branches or pull requests

8 participants