How To: make a swerver drive, make a guide#12
How To: make a swerver drive, make a guide#12CNrailfaner4039 wants to merge 15 commits intomasterfrom
Conversation
|
I'll review this soon- thank you for contributing to the team documentation! |
There was a problem hiding this comment.
This is an excellent start to a guide on swerve drive. Here are some things to note:
- The documentation isn't solely for the programming subteam. This guide covers the programming aspect of coding a swerve drivebase, but we can also add the mechanical and electrical parts to it.
- We used YAGSL this year- but I don't see any
swervelibimports in this guide. It is probably better to keep it consistent. Here is a link to the code for this year: https://github.com/Team2530/RobotCode2026/blob/main/src/main/java/frc/robot/subsystems/SwerveSubsystem.java. - The first code block doesn't have valid code- I think you must have missed a
//before the text to comment it out.
There was a problem hiding this comment.
I see that you are setting the syntax language to java everywhere for code blocks- you can actually specify whichever language you want. To specify markdown for the code block you can use md instead of java after the three backticks.
Also, it would be nice to specify that the docs are made with Material for MKDocs. They have their own documentation website that shows you how to use many of the more complicated features. This link could go in a "See also" or "Further Reading" section.
There was a problem hiding this comment.
There is also a page from the old documentation that is for writing new documentation:
- https://docs.frcteam2530.org/old_docs/writing_documentation/How-to-create-pages/
- https://docs.frcteam2530.org/old_docs/writing_documentation/notes/
I also like how this guide explains how to open the editor to get started.
There was a problem hiding this comment.
Also, be careful to specify when you're describing standard Markdown or extended Markdown.
Comments answer, pls reply and tell me your request.
| @@ -0,0 +1,166 @@ | |||
| # How to make a Swerve Drive base | |||
There was a problem hiding this comment.
This is overview of the YAGSL internals, which have already been documented by the YAGSL team themselves.
We are looking for a documentation of our code (specifically subsystems/SwerveDriveSubsystem.java) and how we use that on our actual drivebase.
There was a problem hiding this comment.
Also, be careful to specify when you're describing standard Markdown or extended Markdown.
Removed extra text from 404 error message.
Reviewed request and competed removal
This isn't finished yet, I'm still working on it
No description provided.