Skip to content
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

Cleanup Root TOC #989

Open
Daltz333 opened this issue Dec 9, 2020 · 2 comments
Open

Cleanup Root TOC #989

Daltz333 opened this issue Dec 9, 2020 · 2 comments

Comments

@Daltz333
Copy link
Member

Daltz333 commented Dec 9, 2020

  • Condense Contributing
  • Condense Networking?
  • Split up Dashboards and Condense
@jasondaming
Copy link
Member

This also ties in to #879
I thought about this some more and here are some of my suggestions:

  • Reduce the Size of the logo. My proposal would be the current height of WPI & FRC part to now also include the WPILib gear
  • Remove Contributing section. Either place as a single bullet under issues or just keep the documentation on latest.
  • Condense Software Tools to: Driver Station, Dashboards, and Misc
  • Move Old Command Based under Command Based
  • Remove Convenience Features and place the only article, Scheduling Functions under roboRIO or something
  • Place all of networking in one section under Hardware or under the RoboRIO section
  • Instead of "What is WPILib" make the section "WPILib" and move the stuff from 2021 Overview and support resources under it
  • Make the current "Basic Programming" section called Misc Programming, it is wildly misleading as is.
  • Make a new section called "Common Robot Problems" or something similar. This will both be for things that aren't quite big enough for a tutorial like: Joysticks, Autonomous, Unit Testing, etc . The new FAQ. Also a few of the articles that don't currently fit in their spot like: Addressable LEDs and Using WPILib Classes to Drive your Robot under actuators.

@Daltz333
Copy link
Member Author

Daltz333 commented Jan 21, 2021

Reduce the Size of the logo. My proposal would be the current height of WPI & FRC part to now also include the WPILib gear

Is there a particular reason for this? I don't think this is necessary.

Remove Contributing section. Either place as a single bullet under issues or just keep the documentation on latest.

This would only save 1 level of space, and make it less contributor friendly in the future. Also we can't keep it on latest, as latest is (master) and stable is (master) during build season. Beta branches have been decided against in the past.

Condense Software Tools to: Driver Station, Dashboards, and Misc

I agree with this, except Misc. Misc is how we get "let's just plop stuff here". I think I'd rather a section with one article then a misc.

Move Old Command Based under Command Based

I disagree with this, this makes it more confusing. We also plan to deprecate old-commandbased in the future so this isn't the route forward.

Place all of networking in one section under Hardware or under the RoboRIO section

I also disagree with this. While networking is hardware, this section doesn't really feature the hardware side as much as just general networking. I prefer to not move things underneath this, since everything is pretty much "networking" (IP Configurations, DHCP, etc).

Instead of "What is WPILib" make the section "WPILib" and move the stuff from 2021 Overview and support resources under it

I partially agree with this. "What is WPILib" is by itself so it doesn't necessarily need to appear in the TOC, but it does explain the mission a little bit. Perhaps this can be reworked into the homepage rewrite. I don't agree moving the overview stuff underneath it, as this is what the layout was previously and that was confusing.

Make the current "Basic Programming" section called Misc Programming, it is wildly misleading as is.

I agree with this.

Make a new section called "Common Robot Problems" or something similar. This will both be for things that aren't quite big enough for a tutorial like: Joysticks, Autonomous, Unit Testing, etc . The new FAQ. Also a few of the articles that don't currently fit in their spot like: Addressable LEDs and Using WPILib Classes to Drive your Robot under actuators.

This statement is pretty vague, I'd like this fleshed out a bit more before any decisions are made on this.

spacey-sooty added a commit to spacey-sooty/frc-docs that referenced this issue Oct 16, 2024
spacey-sooty added a commit to spacey-sooty/frc-docs that referenced this issue Oct 16, 2024
@sciencewhiz sciencewhiz assigned arbessette and unassigned Daltz333 Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants