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

2027 Docs Restructure

Open jasondaming opened this issue 3 months ago • 3 comments

initial restructure according to documentation template: https://docs.google.com/document/d/1hfguBWJAnKySKMACouyjNGWFuWJTAfZ_YTXg_Djp714/edit?tab=t.0

I marked this as a draft pull request because it is no where near ready to merge. I just wanted to get something on paper to hopefully stir "criticism"

jasondaming avatar Oct 05 '25 02:10 jasondaming

My immediate gut feeling is that it's too nested. Why is there a user manual index under a user manual heading? Why can't all of the contents be elevated up so it's all directly under the user manual heading? At the same time, too much information all at once can be problematic, but I wonder if this also hurts discoverability.

Gold856 avatar Oct 05 '25 05:10 Gold856

Part of that is limitations we have of the platform. It bothers me too all of the white (blue?) space between entries in the side bar. It also doesn't allow you to expand and collapse the "titles" the grey "Getting Started"

To make sure I am understanding the proposal you are suggesting the home page look like this (with the ones in red removed): image

jasondaming avatar Oct 05 '25 13:10 jasondaming

I think the headings should match the paths to be consistent unless its something that should be called out separate. Its not a lot of information, its helping tailor the information to the user. The goal is to be helpful for all users, so while it looks like a lot of info, its actually less overwhelming since I can identify with a group and move forward to information explained at my knowledge level.

arbessette avatar Oct 13 '25 18:10 arbessette