1347977 - Move some DevTools technical docs to the tree

Status: RESOLVED FIXED

(DevTools :: General, enhancement)

Description

[Patrick Brosset <:pbro>]

Currently we have many docs in many places. It's hard to find things, and organize them.

We discussed at the Paris work week that we should clean this up.
One concrete thing that came out of it was that docs inside the tree were good (things in /devtools/docs) and that we should keep that for very technical things like architecture, APIs, etc.

So I went over the wiki and listed the pages we have:
https://docs.google.com/document/d/1XrrvgSZka1uEeYynZRf99FI0ejiCIz_rGyuKHrFx8rI/edit#

Some of them, I think, should go in /devtools/docs/

I'll attach a patch soon to move 1 of them, and then will continue with other pages.

Comment 1

[Patrick Brosset <:pbro>]

Attachment: Bug 1347977 - Add docs about highlighters to /devtools/docs;

Review commit: https://reviewboard.mozilla.org/r/121104/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/121104/

Comment 2

[J. Ryan Stinnett [:jryans] (Use needinfo, replies may be slow)]

Comment on attachment 8848127 [details]
Bug 1347977 - Add docs about highlighters to /devtools/docs;

https://reviewboard.mozilla.org/r/121104/#review123022

Looks good to me, thanks for working on it! :)

::: devtools/docs/backward-compatibility.md:1
(Diff revision 1)
> +# Backward Compatibility

There's also a `SUMMARY.md` in this folder that attempts to links to the others here.  Probably makes sense to add a link to this?

Comment 3

[Patrick Brosset <:pbro>]

Comment on attachment 8848127 [details]
Bug 1347977 - Add docs about highlighters to /devtools/docs;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/121104/diff/1-2/

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/a0ce34028d02
Add docs about backward compatibility; r=jryans

Comment 5

[Patrick Brosset <:pbro>]

I'll add more patches here, let's leave it open for now.

Comment 6

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

https://hg.mozilla.org/mozilla-central/rev/a0ce34028d02

Comment 7

[Patrick Brosset <:pbro>]

Comment on attachment 8848127 [details]
Bug 1347977 - Add docs about highlighters to /devtools/docs;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/121104/diff/2-3/

Comment 8

[Patrick Brosset <:pbro>]

Comment on attachment 8848127 [details]
Bug 1347977 - Add docs about highlighters to /devtools/docs;

https://reviewboard.mozilla.org/r/121104/#review123358

r=me for this one because:
- it's only a doc change
- I'm not writing new doc, it existed on the wiki before, I'm just moving it
- I originally wrote this doc on the wiki

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/37d8224ed59c
Add docs about highlighters to /devtools/docs; r=jryans

Comment 10

[Patrick Brosset <:pbro>]

Pushing different commits to mozreview using the same bug isn't a great experience. So let's close this as soon as the next commit lands, and file other bugs if we need to.

Comment 11

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/37d8224ed59c