resource wip

titan2022 · Sep 5, 2024 · f0df167 · f0df167
1 parent 70bbf26
commit f0df167
Show file tree

Hide file tree

Showing 36 changed files with 144 additions and 153 deletions.
diff --git a/source/PreseasonTraining/1_LEDProgramming/index.md b/source/PreseasonTraining/1_LEDProgramming/index.md
diff --git a/source/PreseasonTraining/2_OpenCV_ColorSegmentation/Tutorial.md b/source/PreseasonTraining/2_OpenCV_ColorSegmentation/Tutorial.md
@@ -0,0 +1,3 @@
+# Color-based segmentation in OpenCV Python: Tutorial
+
+TODO: Figure out where we put the tutorial!
diff --git a/source/PreseasonTraining/2_OpenCV_ColorSegmentation/index.md b/source/PreseasonTraining/2_OpenCV_ColorSegmentation/index.md
@@ -0,0 +1,10 @@
+# Color-based segmentation in OpenCV Python
+
+```{toctree}
+---
+maxdepth: 2
+caption: Contents
+titlesonly: true
+---
+Tutorial.md
+```
diff --git a/source/PreseasonTraining/JavaBasics/index.md → ...e/PreseasonTraining/3_JavaBasics/index.md b/source/PreseasonTraining/JavaBasics/index.md → ...e/PreseasonTraining/3_JavaBasics/index.md
diff --git a/...nTraining/TankDriveSimulation/Tutorial.md → ...raining/4_TankDriveSimulation/Tutorial.md b/...nTraining/TankDriveSimulation/Tutorial.md → ...raining/4_TankDriveSimulation/Tutorial.md
diff --git a/...asonTraining/TankDriveSimulation/index.md → ...onTraining/4_TankDriveSimulation/index.md b/...asonTraining/TankDriveSimulation/index.md → ...onTraining/4_TankDriveSimulation/index.md
diff --git a/...Training/AutonomousSimulation/Tutorial.md → ...aining/5_AutonomousSimulation/Tutorial.md b/...Training/AutonomousSimulation/Tutorial.md → ...aining/5_AutonomousSimulation/Tutorial.md
diff --git a/...sonTraining/AutonomousSimulation/index.md → ...nTraining/5_AutonomousSimulation/index.md b/...sonTraining/AutonomousSimulation/index.md → ...nTraining/5_AutonomousSimulation/index.md
diff --git a/...eseasonTraining/ArmSimulation/Tutorial.md → ...easonTraining/6_ArmSimulation/Tutorial.md b/...eseasonTraining/ArmSimulation/Tutorial.md → ...easonTraining/6_ArmSimulation/Tutorial.md
diff --git a/.../PreseasonTraining/ArmSimulation/index.md → ...reseasonTraining/6_ArmSimulation/index.md b/.../PreseasonTraining/ArmSimulation/index.md → ...reseasonTraining/6_ArmSimulation/index.md
diff --git a/source/PreseasonTraining/Mock1/index.md → source/PreseasonTraining/7_Mock/index.md b/source/PreseasonTraining/Mock1/index.md → source/PreseasonTraining/7_Mock/index.md
diff --git a/source/PreseasonTraining/8_2024CodeOverview/index.md b/source/PreseasonTraining/8_2024CodeOverview/index.md
@@ -0,0 +1,17 @@
+# Lesson 8: 2024 Code overview
+
+```{toctree}
+---
+maxdepth: 2
+caption: Contents
+titlesonly: true
+---
+```
+
+## Agenda
+
+* Overview of last years code  
+* Every command and subsystem  
+* Vision code  
+* QnA  
+* Watch old matches for strategy and inspiration
diff --git a/source/PreseasonTraining/Mock2/index.md b/source/PreseasonTraining/Mock2/index.md
diff --git a/source/PreseasonTraining/index.md b/source/PreseasonTraining/index.md
@@ -8,12 +8,11 @@ titlesonly: true
 ---
 Overview/index.md
 LEDProgramming/index.md
-OpenCV_ColorSegmentation/index.md
-JavaBasics/index.md
-TankDriveSimulation/index.md
-AutonomousSimulation/index.md
-ArmSimulation/index.md
-Mock1/index.md
-Mock2/index.md
-2024CodeOverview/index.md
+2_OpenCV_ColorSegmentation/index.md
+3_JavaBasics/index.md
+4_TankDriveSimulation/index.md
+5_AutonomousSimulation/index.md
+6_ArmSimulation/index.md
+7_Mock/index.md
+8_2024CodeOverview/index.md
 ```
diff --git a/source/Resources/Applications/git.md b/source/Resources/Applications/git.md
@@ -0,0 +1,62 @@
+# Git
+
+This is a short cheatsheet on VSCode source control usage. Feel free to use Git CLI if you already have experience or want to learn it. Full guide on VSCode source control can be found [here](https://code.visualstudio.com/docs/sourcecontrol/overview).
+
+## Structure
+
+* A Git project is called a repository
+* Github is a Git platform for hosting Git projects online
+* Inside a repo, you can create branches
+* Typically, the `main` or `master` is used in production
+* Each branch contains a list of changes called commits
+* Each commit contains changes to files and a message
+* All commits are created locally; you need to do a push to upload them to Github
+* To download changes, do a pull
+* To update your list of branches, do a fetch (VSCode has an option to do this automatically)
+* You can dublicate branches, work on them separately, and merge them back together
+* This allows everyone to work on different features independently without breaking things
+
+## Cloning
+
+* Cloning is downloading a repository
+* First, click on green Code button and copy the HTTPS link
+
+![Copying HTTPS link](./git_clone.png "Copying HTTPS link")
+
+* Second, go to VSCode source control tab and click clone
+
+![Cloning](./vsc_clone.png "Cloning")
+
+* Paste your link and press enter
+* Select a folder to save the project in
+
+![Pasting](./vsc_paste.png "Pasting")
+
+* Open the same folder next time to open the project
+* Please don't clone the repo every time you want to work on it!
+
+## Committing
+
+* First, make the changes you want to make
+* Go to source control tab and press `+` for all files you want to include in your commit
+* Write a message (a description) for your commit (this step is required)
+* You can press `-` for files you want to remove from your commit
+* Once you are ready, press commit button
+
+## Pushing & Pulling
+
+* After committing, you need to push
+* You can click VSCode's blue "sync" button, which will push and pull at the same time
+* Otherwise, you can click on additional actions and click push or pull
+
+![Push/pull actions](./vsc_push_pull.png "Push/pull actions")
+
+## Switching branches
+
+* To check which branch you are on, view the message input bar 
+
+![Checking branch](./vsc_branch.png "Checking branch")
+
+## Merging
+
+* 
diff --git a/source/Resources/Applications/git_clone.png b/source/Resources/Applications/git_clone.png
diff --git a/source/Resources/Applications/index.md b/source/Resources/Applications/index.md
@@ -0,0 +1,10 @@
+# Applications
+
+```{toctree}
+---
+maxdepth: 2
+caption: Contents
+titlesonly: true
+---
+git.md
+```
diff --git a/source/Resources/Applications/vsc_branch.png b/source/Resources/Applications/vsc_branch.png
diff --git a/source/Resources/Applications/vsc_clone.png b/source/Resources/Applications/vsc_clone.png
diff --git a/source/Resources/Applications/vsc_paste.png b/source/Resources/Applications/vsc_paste.png
diff --git a/source/Resources/Applications/vsc_push_pull.png b/source/Resources/Applications/vsc_push_pull.png
diff --git a/source/Resources/3_Coprocessors/index.md → source/Resources/Coprocessors/index.md b/source/Resources/3_Coprocessors/index.md → source/Resources/Coprocessors/index.md
diff --git a/source/Resources/2_CppProgramming/index.md → source/Resources/CppProgramming/index.md b/source/Resources/2_CppProgramming/index.md → source/Resources/CppProgramming/index.md
diff --git a/source/Resources/1_JavaProgramming/index.md → source/Resources/JavaProgramming/index.md b/source/Resources/1_JavaProgramming/index.md → source/Resources/JavaProgramming/index.md
@@ -1,5 +1,14 @@
 # Java / roboRIO Programming
 
+```{toctree}
+---
+maxdepth: 2
+caption: Contents
+titlesonly: true
+---
+installation.md
+```
+
 ## Introduction
 
 The [official WPILib documentation](https://docs.wpilib.org/en/stable/) has the most amount of content regarding FRC programming. Reading through the entire Wiki will set you ahead of majority of FRC programmers. Some components do not have official WPILib support and contain their documentation externally, such as [Phoenix 6](https://v6.docs.ctr-electronics.com/en/stable/) and [NavX2](https://pdocs.kauailabs.com/navx-mxp/)

diff --git a/source/Resources/4_Linux/index.md → source/Resources/Linux/index.md b/source/Resources/4_Linux/index.md → source/Resources/Linux/index.md
diff --git a/source/Resources/RobotDesign/index.md b/source/Resources/RobotDesign/index.md
diff --git a/source/Resources/index.md b/source/Resources/index.md
@@ -2,7 +2,7 @@
 
 ## Documentation and other websites
 
-Use the following resources to learn more about FRC programming and other topics related to the team. These are simply recommendations from the team at the time of writting and might be irrelevant even a short time after. Always check updated sources.
+Use the following resources to learn more about FRC programming and other topics related to the team. These are simply recommendations from the team at the time of writting and might be irrelevant even a short time after. Always check updated sources!
 
 
 ```{toctree}
@@ -12,8 +12,10 @@ caption: Contents
 titlesonly: true
 ---
 StyleGuide.md
-1_JavaProgramming/index.md
-2_CppProgramming/index.md
-3_Coprocessors/index.md
-4_Linux/index.md
+Applications/index.md
+RobotDesign/index.md
+JavaProgramming/index.md
+CppProgramming/index.md
+Coprocessors/index.md
+Linux/index.md
 ```
diff --git a/source/TeamHistory/index.md b/source/TeamHistory/index.md
@@ -0,0 +1 @@
+# Team #2022 History
diff --git a/source/TitanDashboard/index.md b/source/TitanDashboard/index.md
diff --git a/source/TitanProcessing/2_AprilTags/index.md b/source/TitanProcessing/2_AprilTags/index.md
diff --git a/source/TitanProcessing/3_Localization/index.md b/source/TitanProcessing/3_Localization/index.md
diff --git a/source/TitanProcessing/4_Networking/index.md b/source/TitanProcessing/4_Networking/index.md
diff --git a/source/TitanProcessing/AprilTags/index.md b/source/TitanProcessing/AprilTags/index.md
@@ -0,0 +1,7 @@
+# AprilTag Detection
+
+## Reading Configuration
+
+## Detection
+
+## Multithreading
diff --git a/source/TitanProcessing/Localization/index.md b/source/TitanProcessing/Localization/index.md
@@ -0,0 +1 @@
+# Localization
diff --git a/source/TitanProcessing/index.md b/source/TitanProcessing/index.md
@@ -4,6 +4,8 @@
 
 [Titan Processing](https://github.com/titan2022/Titan-Processing) is the official vision library created and used by Titan Robotics since the 2023-2024 season. It is targetted for compilation on a coprocessor, and for this reason it includes a networking module. The main capability is detecting AprilTags and determining the robot pose through localization and filtering it using an Extended Kalman Filter.
 
+Unlike Titan Algorithms, Titan Processing operates on a rolling release model, meaning that there is no explicit versioning. This is because most of vision code in production is written in this library. This requires frequent bug fixes and modifications, so try to rebuild this library as often as possible. You can refer to specific Titan Processing installations with their respective Git commit messages or codes.
+
 ```{toctree}
 ---
 maxdepth: 2
@@ -15,4 +17,8 @@ Calibration/index.md
 AprilTags/index.md
 Localization/index.md
 Networking/index.md
-```
+```
+
+## Contributing
+
+To contribute, create your own branch or fork with necessary modifications and initiate a merge or pull request into `main`.
diff --git a/source/index.md b/source/index.md
@@ -1,5 +1,7 @@
 # Titan Robotics #2022 Documentation
 
+Welcome to the Titan Robotics #2022 official programming documentation! Here you can find all available guides on our software and other FRC related projects. There are also some pages on strategy and design.
+
 ```{toctree}
 ---
 caption: Contents
@@ -10,4 +12,5 @@ Resources/index.md
 TitanAlgorithms/index.md
 TitanProcessing/index.md
 TitanDashboard/index.md
+TeamHistory/index.md
 ```
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Color-based segmentation in OpenCV Python: Tutorial

		TODO: Figure out where we put the tutorial!