684011 - Page-mod documentation should link to worker's documentation earlier.

Status: RESOLVED FIXED

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

Description

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

Currently, the first link to worker's documentation is way down in "Mapping workers to tabs", which is below the halfway point in the page.

But 'worker' is first mentioned up near the top in "Communicating With Content Scripts".

I would move the link for worker's docs up to that first mention of 'worker', personally.



If the big "working with content scripts" rewrite will change the page-mod docs, too, feel free to wontfix this.

Comment 1

[Jeff Griffiths (:canuckistani) (:⚡︎)]

I just checked, the patch ( or my current modifications to said patch ) for bug 679479 do not edit page-mod.md. This should definitely be a separate bug.

Comment 2

[Jeff Griffiths (:canuckistani) (:⚡︎)]

Attachment: Move the link to the worker docs

Patch to move the link to the worker docs to the earliest sensible instance of the word worker. We could move it one line earlier but stylistically I think this placing of the link makes it more find-able.

Comment 3

[Will Bamberg [:wbamberg]]

Comment on attachment 557640 [details]
Move the link to the worker docs

This patch doesn't apply cleanly any more. I've regenerated one that does, and attached it. Shall I just push it? It seems silly to ask for reveiw again, for such a trivial change...

Comment 4

[Will Bamberg [:wbamberg]]

Attachment: another patch

Comment 5

[Jeff Griffiths (:canuckistani) (:⚡︎)]

Comment on attachment 650560 [details] [diff] [review]
another patch

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

Looks good.

Comment 6

[[github robot]]

Commit pushed to master at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/98940794970e265960c71657f3d24d87c627a2e7
Fix bug 684011 - Page-mod documentation should link to worker's documentation earlier.; r=@canuckistani