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

Improve Categorization of Docs #2377

Open
jruaaa opened this issue Oct 30, 2023 · 2 comments
Open

Improve Categorization of Docs #2377

jruaaa opened this issue Oct 30, 2023 · 2 comments

Comments

@jruaaa
Copy link

jruaaa commented Oct 30, 2023

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
Copy link

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

https://documentation.divio.com/

image

@jruaaa
Copy link
Author

jruaaa commented Nov 1, 2023

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

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