Closed Bug 1045882 Opened 5 years ago Closed 5 years ago

Move protocol.js tutorial gist into the tree

Categories

(DevTools :: General, defect)

x86
macOS
defect
Not set

Tracking

(Not tracked)

RESOLVED FIXED
Firefox 35

People

(Reporter: fitzgen, Assigned: fitzgen)

Details

Attachments

(1 file)

Seriously, everytime I have to use protocol.js I forget how it works and need to track down this random gist[0] because the actual protocol.js file doesn't really explain itself well to a reader who doesn't already get it.

Can we just put it as a .md file or big ass comment at the top of the file or something?

[0] https://gist.github.com/campd/5460401
If I type 'gis' to the awesomebar it goes "What? You want to read the protocol.js docs *again*???". :)

Maybe we should put this on MDN and put lots of links to it in protocol.js?
(In reply to Joe Walker [:jwalker] from comment #1)
> If I type 'gis' to the awesomebar it goes "What? You want to read the
> protocol.js docs *again*???". :)
> 
> Maybe we should put this on MDN and put lots of links to it in protocol.js?

We moved the Debugger API docs into the tree, and it has worked out great. Now when we update or change the debugger api, we can require docs with the patch and review them in our normal workflow. Plus we always know that the docs are up to date with the version of firefox we are working with.

I think we should leverage those benefits here as well.
Assignee: nobody → nfitzgerald
Status: NEW → ASSIGNED
Comment on attachment 8498924 [details] [diff] [review]
protocol-js-docs.patch

Review of attachment 8498924 [details] [diff] [review]:
-----------------------------------------------------------------

Such great writing, Nick.
Attachment #8498924 - Flags: review?(jryans) → review+
https://hg.mozilla.org/integration/fx-team/rev/81c77b980a8d
Flags: in-testsuite-
Keywords: checkin-needed
Whiteboard: [fixed-in-fx-team]
https://hg.mozilla.org/mozilla-central/rev/81c77b980a8d
Status: ASSIGNED → RESOLVED
Closed: 5 years ago
Resolution: --- → FIXED
Whiteboard: [fixed-in-fx-team]
Target Milestone: --- → Firefox 35
Flags: qe-verify-
Product: Firefox → DevTools
You need to log in before you can comment on or make changes to this bug.