572069 - documentation sidebar should link to tutorial, SDK docs

Status: RESOLVED FIXED

(Mozilla Labs Graveyard :: FlightDeck, defect)

Description

[Myk Melez [:myk] [@mykmelez]]

The documentation sidebar should include links to the tutorial and the SDK docs, and the links should appear in the following order and presentation:

Tutorial            <-- /tutorial/

---------------     <-- Use dividing lines or some other way of separating
                        sections to distinguish them from each other.
Core Library        <-- This links to the "all APIs on one page" page.  Call it
                        "Core Library" rather than "jetpack-core".
api-utils           <-- Note: it isn't necessary to have a "Modules" header
byte-streams            here, as we aren't providing any other documentation
collection              for the library.
...

---------------

Add-ons Builder SDK <-- https://jetpack.mozillalabs.com/sdk/latest/docs/

Comment 1

[Piotr Zalewa [:zalun]]

Done

Comment 2

[Myk Melez [:myk] [@mykmelez]]

Thanks, it looks pretty good!  Just two issues...

First, the sidebar is missing the Add-ons Builder SDK link.

Second, it looks like the Core Library header is in a separate "section" from the individual module links, since horizontal rules (lines) are being used to separate sections (Tutorial, Core Library, SDK) as well as to underline the Core Library section header.

This should use horizontal rules either to separate sections or to underline headers, but not both, i.e.:

        Tutorial
        
        ------------
        
        Core Library
        
        api-utils
        byte-streams
        collection
        ...
        
        ------------
        
        Add-ons Builder SDK

Or (using spacing to separate sections):

        Tutorial
        
        
        Core Library
        ------------
        api-utils
        byte-streams
        collection
        ...
        
        
        Add-ons Builder SDK

Comment 3

[Piotr Zalewa [:zalun]]

fixed http://github.com/zalun/FlightDeck/commit/e2f25db6c3d57de16425e0dbf6aa77a6fc160f0d