Ensure content and appearance parity of FlightDeck docs with that of the SDK site's

RESOLVED FIXED in 0.6

Status

P1
normal
RESOLVED FIXED
8 years ago
8 years ago

People

(Reporter: dbuchner, Assigned: wbamberg)

Tracking

unspecified
Dependency tree / graph

Details

(Reporter)

Description

8 years ago
There are several areas where the doc output in FlightDeck does not contain the same amount of content as the SDK site's equivalent. Also, the styling of the FlightDeck doc pages needs tweaking so that readers can better distinguish between different types of content (descriptions, methods, property details, etc).
I've been asking for a precise definition of the doc included in the SDK. 
It is necessary to write a proper parser
(In reply to comment #1)
> I've been asking for a precise definition of the doc included in the SDK. 
> It is necessary to write a proper parser

Who should this bug be assigned to?
Priority: -- → P1
(Reporter)

Comment 3

8 years ago
We just had a docs person sign a contract today, so I will push it to him when he gets all setup.
Can this use MDN?
(Assignee)

Updated

8 years ago
Assignee: nobody → wbamberg
Status: NEW → ASSIGNED
(Assignee)

Comment 5

8 years ago
I'd like to define the scope of this defect a bit more. I expect it to include 2 pieces, which I'll address as separate bugs. 

Bug 605627: 
    - extend the current API reference syntax so it understands classes
    - update the toolchain (both renderapi.js and the AOB code)so it understands the new syntax and can emit the appropriate HTML
    - update the Markdown to include the new syntax

Bug 605629:
    - update the css which controls the presentation of the API reference material for the AOB so it's more readable. 

There are some extras which I don't expect to address in this particular defect but should probably be covered by some new bugs. For example:
    - syntax highlighting for code examples
    - including diagrams in docs
    - any other extensions to the Markdown syntax (events, singletons...)
    - additions/fixes to the content of the docs

As for using MDN: I think this is a good idea but that also won't happen in the context of this bug.
(Assignee)

Updated

8 years ago
Depends on: 605627, 605629
Target Milestone: -- → 1.0
Target Milestone: 1.0 → 0.6
(Reporter)

Comment 6

8 years ago
Nice work, the Builder docs just got 168,402,372% better!
Status: ASSIGNED → RESOLVED
Last Resolved: 8 years ago
Resolution: --- → FIXED

Updated

8 years ago
Component: FlightDeck → FlightDeck
Product: Mozilla Labs → Mozilla Labs Graveyard
You need to log in before you can comment on or make changes to this bug.