search

wpilibsuite / frc-docs

Official FRC Documentation powered by Read the Docs
https://docs.wpilib.org
Other
149 stars 264 forks source link

Improve Categorization of Docs #2377

Open jlruan opened 1 year ago

jlruan commented 1 year ago

Currently WPILib docs has a mix of electrical, mechanical, and software topics interspersed without any sort of order and has redundant pages. It isn't readable for anything else other than reference and it doesn't have a great reading order/flow or progression in difficulty. Reorganizing it by component would make it easier to learn from and help people find what they're looking for, especially for people who don't know what they're looking for.

This is a previous discussion about this topic and my proposed order is at the bottom: https://docs.google.com/document/d/1SaT6fXab_EceAv7dU0OwJvF9TTn1C0LCyE1ZmFLu8vs/edit?usp=sharing

TechplexEngineer commented 1 year ago

This looks great! Just want to share a common documentation structure used by many OSS projects (Django and others)

https://documentation.divio.com/

image

jlruan commented 1 year ago

new doc since the old one was getting a bit messy and old: https://docs.google.com/document/d/1bCAAL5KTePPiV7iY0Kgbb0RIWnRxoks1t_iEMbF4T04/edit