frc-docs icon indicating copy to clipboard operation
frc-docs copied to clipboard

Enhanced Troubleshooting Guides

Open gerth2 opened this issue 3 years ago • 1 comments

Attempting to bite off the following issues:

https://github.com/wpilibsuite/frc-docs/issues/1796 https://github.com/wpilibsuite/frc-docs/issues/1794 https://github.com/wpilibsuite/frc-docs/issues/1793 https://github.com/wpilibsuite/frc-docs/issues/1797 https://github.com/wpilibsuite/frc-docs/issues/1795

New Troubleshooting section to be added, with some general debug advice, pages for high-level "classes" of issues to be addressed.

General advice should include both good "mindsets" to have for effective troubleshooting, as well as an introduction to the tools and sources of information to use to gather info about the problem

Each class of issues should have a list of "common symptoms" associated with them, and common root causes to check.

gerth2 avatar Aug 21 '22 16:08 gerth2

For the problem/solution portions, the "problem" should be written in the first person from the perspective of a student so that it is easier to google.

On example, Unable to connect to your robot? should be closer to Can't connect to my robot or How do I connect to my robot?

TheTripleV avatar Aug 28 '22 07:08 TheTripleV