-
Notifications
You must be signed in to change notification settings - Fork 268
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update AdvantageScope docs #2418
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good stuff I think we should merge this ASAP with a couple changes.
We can defer this to a different PR if you want but I really thing we should have a section on publishing swerve states (I don't remember the current state of structs?). For troubleshooting and getting started with Swerve this is one of the most helpful things teams can do
A few changes:
|
It is not implemented yet: robotpy/mostrobotpy#5 |
I don't think there is anything preventing this from being merged with a little cleanup. |
FWIW python struct publishing is now merged: robotpy/mostrobotpy#50 |
These updates reflect AdvantageScope's inclusion in the WPILib installer for 2024, with a dedicated page and references from relevant locations in the rest of the docs. The idea is to keep the main AdvantageScope docs separate but make the tool more discoverable.
I think the main questions here relate to organization. The AdvantageScope page is under "Telemetry" in this version, but I could see arguments for putting it under "Dashboards" (with Glass, which is also a programmer's tool) or "Software Tools" (with OutlineViewer). I also added AdvantageScope references to the pages for Field2d, Mechanism2d, and plots; these are currently organized under "Glass", but the Field2d and plots pages are also part of "Robot Simulation" where I think the inclusion of AdvantageScope makes more sense. There's a bit of a disconnect now between those features and Glass, but maybe keeping AdvantageScope as a side reference on those pages is an OK solution? I'm open to suggestions.
I'm opening this as a draft for now since the explanation for how to open AdvantageScope won't actually work until it's included in the tools menu and file associations are added for Windows.