WIP for 2027 - Time to Get Discussions going - #3320
arbessette wants to merge 29 commits into
Conversation
be203f1 to
88df58f
Compare
for all. I don't like pages that FRC comes before FTC, might be worth moving FTC to appear first. I had help from Claude, so wording may be wrong still. Draft open for discussion: we can keep all, parts, or none of it.
|
It looks great, but I'm worried about the maintainability of a bunch of raw HTML. I'm guessing it also doesn't translate. Have you seen how far you can get with the customization of sphinx-design? |
I just saw this message, need to work on my github notifications. I'll look into this. |
…T also fix step 1 layout
| <a class="wl-core-card" href="docs/software/dashboards/index.html"><div class="wl-core-title">Dashboards</div><div class="wl-core-desc">Elastic, AdvantageScope, Glass, and NetworkTables for real-time telemetry.</div></a> | ||
| <a class="wl-core-card" href="docs/software/advanced-controls/index.html"><div class="wl-core-title">Advanced Controls</div><div class="wl-core-desc">PID, feedforward, state-space, kinematics, and system identification.</div></a> | ||
| <a class="wl-core-card" href="docs/software/wpilib-tools/robot-simulation/index.html"><div class="wl-core-title">Simulation</div><div class="wl-core-desc">Test robot code on your laptop : no hardware required.</div></a> | ||
| <a class="wl-core-card" href="https://github.wpilib.org/allwpilib/docs/release/java/index.html"><div class="wl-core-title">API Reference</div><div class="wl-core-desc">Java, C++, and Python class and method documentation.</div></a> |
There was a problem hiding this comment.
This only links to the java API docs. There probably needs to be a landing page with the three links.
There was a problem hiding this comment.
made a new landing page
| # -- Project information ----------------------------------------------------- | ||
|
|
||
| project = "WPILib Documentation" | ||
| project = "FIRST Robotics" |
| # Configure OpenGraph support | ||
| ogp_site_url = "https://docs.wpilib.org/en/stable/" | ||
| ogp_site_name = "WPILib Documentation" | ||
| ogp_site_name = "FIRST Robotics Documentation" |
| <div class="wl-ret-label wl-frc-label">FRC</div> | ||
| <h3 class="wl-ret-h">Pre-Season Checklist</h3> | ||
| <ul> | ||
| <li>Download and run the <strong>2027 WPILib installer</strong></li> |
There was a problem hiding this comment.
These should all have links to the appropriate articles
| <h3 class="wl-ret-h">Pre-Season Checklist</h3> | ||
| <ul> | ||
| <li>Download and run the <strong>2027 WPILib installer</strong></li> | ||
| <li>Flash your Systemcore using <strong>FRC 2027 Game Tools</strong></li> |
… darkmode and adjust a couple more pages
zachwaffle4
left a comment
There was a problem hiding this comment.
In general I think docs should either be written as if FTC is already using systemcore, or we should wait until the 2027-2028 season to mention FTC at all.
| WPILib is the standard software library for programming | ||
| *FIRST*\ |reg| robots. | ||
| It provides the classes and tools needed to control motors, read sensors, | ||
| communicate with the Driver Station, and run autonomous routines — across |
There was a problem hiding this comment.
| communicate with the Driver Station, and run autonomous routines — across | |
| communicate with the Driver Station, and run autonomous routines across |
| - NetworkTables browser | ||
| - ✓ | ||
| - ✓ | ||
| * - **Shuffleboard** |
There was a problem hiding this comment.
I feel like Shuffleboard shouldn't be mentioned at all since it was removed; teams who used it (of which there were like 3 anyway) will find it was removed in the "new for 2027" page.
| - FRC DS (Windows) | ||
| - FRC DS (Windows) |
There was a problem hiding this comment.
| - FRC DS (Windows) | |
| - FRC DS (Windows) | |
| - _FIRST_ DS (Windows, MacOS, Linux) | |
| - _FIRST_ DS (Windows, MacOS, Linux) |
Maybe mention that it is only legal on Windows though
| * - **SmartDashboard** | ||
| - *(Removed 2027)* | ||
| - Use Elastic instead. | ||
| * - **Shuffleboard** | ||
| - *(Removed 2027)* | ||
| - Use Elastic instead. |
There was a problem hiding this comment.
I would just get rid of these since they don't exist.
|
|
||
| .. grid-item-card:: What are vendor libraries? | ||
|
|
||
| Hardware vendors (REV, CTRE, etc.) ship WPILib extension |
There was a problem hiding this comment.
Also mention that many vendordeps that are purely software (eg PhotonLib and PathPlannerLib) exist.
| :link-type: doc | ||
| :class-card: sw-card-frc | ||
|
|
||
| **FRC** |
There was a problem hiding this comment.
| **FRC** | |
| **FRC + FTC With Systemcore** |
| *Workspaces* with a Deploy button to select which one runs on | ||
| the Systemcore. Simulation is not planned for OnBot environments. | ||
|
|
||
| **FTC REV Duo** |
There was a problem hiding this comment.
to be entirely honest I think there's no point in this section at all considering we've already said "if you're using the android system go to ftc-docs" at least 7 times on the other pages
|
On the FTC with WPILib page, there's multiple mentions of the DUO system. While I understand that the control and expansion hubs are technically DUO (as in, that's what they're listed as on Rev's site), this feels very confusing as DUO is more of a product line than a control system. I personally associate DUO more with the mechanical products than the control and expansion hubs, and it feels weird to classify the control system based on a vendor's arbitrary classification of it rather than the functional impact for how it's programmed/used, especially considering DUO products (expansion hubs) can be used in the hybrid control system option with WPILib (I believe, not sure I'm 100% up to date on what options will be legal). I feel like it would be more appropriate to refer to the old control system as the legacy control system (phones or control hubs), and call out that the new or hybrid control system options will be what you use with WPILib, while the pure legacy option will use the existing FTC SDK. |
|
I've been referring to the existing FTC system as "the Android-based FTC Control System" which also aligns with the Competition Manual. |
|
Thank you for this feedback, I agree with you I think the legacy system or the Android-based FTC control system makes more sense than DUO. I am less experienced with FTC than FRC, so this helpful. This is a prototype of what documentation could look like which means its rough under the hood to try new things out. This will not be the final form of the documentation. The goal is to try to make the documentation is more user friendly for the beginners, and maintain all the valuable information for the advanced users. It is also a prototype to see how FTC and FRC documentation can be made synchronous. The final form will be based on feedback and more streamlined under the hood |
Co-authored-by: Zach Harel <zach.harel42@gmail.com>


Major changes to homepage and getting started, trying to keep one page for all. I don't like pages that FRC comes before FTC, might be worth moving FTC to appear first. I had help from Claude, so wording may be wrong still.
Draft open for discussion: we can keep all, parts, or none of it.