Hello Docs Team!
I just landed a new design for the contributor handbooks, courtesy @sonjanyc (mockup is here). You can see them on the core, mobile, docs, and polyglot handbooks, among others. The design is still a little rough around the edges, but the bulk of it is there. Namely, here’s some issues I’ve noticed:
- There’s a hover for headings in chapters box
- Content doesn’t properly wrap around the “topics” box
- We need to add a handbook name to each handbook, along with a design (#439)
- The “Watch this page” widget needs to move to be in the actions bar (#437)
- In the polyglots handbook, for admins, “Flag Unresolved” is shown (#436)
Last but not least, I need a decision from y’all.
Currently, we list all hierarchal subpages on the page they’re from. For example, in the core handbook, on the Coding Standards page, we show the subpages as a (undesigned) list. The decision we need made is whether to keep that list and design it or to remove the list entirely. Keep in mind the Chapters sidebar can be organized however you’d like; it doesn’t need to be hierarchal. If we remove the Pages list, we’ll need to make sure the content is properly linked within the page.
What say you?
Other things I should mention are that we should document these things somewhere:
- The starting header tag in any page should be an <h2> to keep the topics box designed. (I went through and fixed this on the core and mobile handbooks.)
- The Chapters sidebar is a custom menu and can be organized however you like.
- Currently, the headings in the Chapters sidebar are merely re-styled <a> tags with # as the href. We’ll probably be changing this, however.
Finally, please note that this design is only for the contributor handbooks. The developer handbooks will have a style that matches devhub.