Skip to content

How To: make a swerver drive, make a guide#12

Open
CNrailfaner4039 wants to merge 15 commits intomasterfrom
Swerve-update-2026
Open

How To: make a swerver drive, make a guide#12
CNrailfaner4039 wants to merge 15 commits intomasterfrom
Swerve-update-2026

Conversation

@CNrailfaner4039
Copy link
Copy Markdown
Contributor

No description provided.

@michael-m-2983
Copy link
Copy Markdown
Member

I'll review this soon- thank you for contributing to the team documentation!

@michael-m-2983 michael-m-2983 changed the title Add for testing porpose Add for testing purpose Apr 11, 2026
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 swervelib imports 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is also a page from the old documentation that is for writing new documentation:

I also like how this guide explains how to open the editor to get started.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, be careful to specify when you're describing standard Markdown or extended Markdown.

Comment thread docs/404.html
@CNrailfaner4039 CNrailfaner4039 dismissed michael-m-2983’s stale review April 11, 2026 18:56

Comments answer, pls reply and tell me your request.

@spoopr spoopr self-requested a review April 11, 2026 19:04
@CNrailfaner4039 CNrailfaner4039 changed the title Add for testing purpose How To: make a swerver drive, make a guide Apr 11, 2026
spoopr
spoopr previously requested changes Apr 11, 2026
@@ -0,0 +1,166 @@
# How to make a Swerve Drive base
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, be careful to specify when you're describing standard Markdown or extended Markdown.

Comment thread docs/404.html
Removed extra text from 404 error message.
@CNrailfaner4039 CNrailfaner4039 requested a review from spoopr April 11, 2026 19:25
@CNrailfaner4039 CNrailfaner4039 dismissed spoopr’s stale review April 11, 2026 19:26

Reviewed request and competed removal

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants