Add necessary examples to be linked from frc-docs

Question

Add necessary examples to be linked from frc-docs

virtuald opened this issue 2 years ago · 15 comments

If RobotPy is to be included in frc-docs (see initial PR), then we need to have existing working examples that can be linked to from the documentation that match the WPILib examples closely. By running the following on frc-docs:

grep -r --no-filename remoteliteralinclude * | grep java | sort | uniq

I get the following examples required:

Here are additional examples that need to be created too:

I tried using ChatGPT to do automated translation of examples, and it's pretty good! Here's a prompt I started with that I got reasonable results with:

RobotPy code translator will translate code from WPILib Java to RobotPy python. The output python code is semantically the same as the original java code, and has identical comments. The output python code is complete and contains all of the code present in the original Java code. Here is the input code for the translator, output only the output code:

Answer 1 · 2023-01-07T02:10:44.000Z

@mrguisamuel and @BerkeSinanYetkin (or anyone else) if you're interested, now that we have a lot of these examples someone needs to add them to frc-docs? I did one of them at wpilibsuite/frc-docs#2019, but obviously there's a lot more.

Answer 2 · 2023-01-07T04:32:53.000Z

@mrguisamuel and @BerkeSinanYetkin (or anyone else) if you're interested, now that we have a lot of these examples someone needs to add them to frc-docs? I did one of them at wpilibsuite/frc-docs#2019, but obviously there's a lot more.

Can't we complete all of them and add them through a grand PR? In my timezone it is already kickoff day, examples we haven't done don't seem like a whole lot of work. Maybe we can divide the workload and finish all of them after kickoff?

Also, happy kickoff day everyone!

Answer 3 · 2023-01-07T05:34:39.000Z

In my timezone it's almost 1am, and I still have a bunch of stuff left for the RobotPy 2023 release (mostly documentation at this point). :)

Answer 4 · 2023-02-06T22:28:49.000Z

seems like we got everything rounded up

Answer 5 · 2023-12-01T06:16:42.000Z

Still need all of these, here is the PR to add them. I noticed a few were on the list above as done but I couldn't find them in the directory:
SwerveBot
Axis Camera Sample
AprilTagsVision
Gears Bot
MecanumControllerCommand
SwerveControllerCommand
StateSpaceFlywheelSysId
StateSpaceElevator
StateSpaceArm
StateSpaceDriveSimulation
SimpleDifferentialDriveSimulation
DMA

Answer 6 · 2023-12-02T19:46:21.000Z

A bunch of those examples are in the commands subdirectory.

Answer 7 · 2023-12-03T20:12:09.000Z

That does not seem at all intuitive. I think that should be fixed. There are many other examples that could be grouped but aren't.

Answer 8 · 2023-12-03T22:30:05.000Z

They're grouped by the commands dependency. I presume you mean we should group our CV examples (since we don't install OpenCV things on the robot by default)?

Answer 9 · 2023-12-03T22:32:54.000Z

Yes, the groupings suck. I like the organization idea in #74?

Answer 10 · 2023-12-08T03:38:05.000Z

The list above has been updated

Answer 11 · 2023-12-21T01:29:17.000Z

Still need all of these, here is the PR to add them. I noticed a few were on the list above as done but I couldn't find them in the directory:

Answer 12 · 2024-01-08T02:50:34.000Z

Could state space elevator be checked off please? I accidentally ported the example when it was already written because I just looked at the list and my clone of the repo hadn't updated

Answer 13 · 2024-01-08T15:00:14.000Z

Should be updated now.

Answer 14 · 2024-01-08T23:39:09.000Z

The XRP Reference might need to be ported for the vscode-wpilib reference example:
https://docs.wpilib.org/en/stable/docs/xrp-robot/programming-xrp.html