641863 - SDK docs should hide tutorials by default, and show all reference docs by default

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect)

Description

[Will Bamberg [:wbamberg]]

Instead of hiding everything in Internals, and showing everything in Developer guide, the navigation sidebar should, by default, show the package reference docs for both Internals and Dev Guide, and hide the tutorials for both Internals and Dev Guide.

Like this:

 - Developer Guide
  - Tutorials ->
  - Reference
    - addon-kit
      - clipboard
      - context menu

 - Internals Guide
  - Tutorials ->
  - Reference
    - api-utils
      - api-utils
      - app-strings

Comment 1

[Will Bamberg [:wbamberg]]

Attachment: Hide tutorials, and some other style changes

Here's a patch to the sidebar to hide everything except the Dev Guide/Reference by default. 

I made a few other minor style changes:
- main text: gray->black
- H2: red->black
- smaller site title + logo, for more usable vertical space
- borders and darker blue for the sidebar, to make it stand out better

I also added the add-on favicon, which is for bug 602915.

This code's also here: https://github.com/wbamberg/jetpack-sdk/tree/641863 if that works better for you.

We're going to get help from a real graphic designer before 1.0, but I think this is worth landing anyway.

Comment 2

[Dietrich Ayala (:dietrich)]

Comment on attachment 522473 [details] [diff] [review]
Hide tutorials, and some other style changes

That sounds great, a huge improvement for repeat-visitors that use it as a reference. Patch looks fine, r=me.

Comment 3

[Will Bamberg [:wbamberg]]

Thanks Dietrich!
Fixed by: https://github.com/mozilla/addon-sdk/commit/3aa49d0c38c3514576d6bbc5d736b5469667ffa9