Move some DevTools technical docs to the tree

RESOLVED FIXED in Firefox 55

Status

enhancement
RESOLVED FIXED
2 years ago
Last year

People

(Reporter: pbro, Assigned: pbro)

Tracking

unspecified
Firefox 55
Dependency tree / graph

Firefox Tracking Flags

(firefox55 fixed)

Details

Attachments

(1 attachment)

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 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?
Attachment #8848127 - Flags: review?(jryans) → review+
Pushed by pbrosset@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/a0ce34028d02
Add docs about backward compatibility; r=jryans
I'll add more patches here, let's leave it open for now.
Keywords: leave-open
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
Attachment #8848127 - Flags: review+
Pushed by pbrosset@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/37d8224ed59c
Add docs about highlighters to /devtools/docs; r=jryans
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.
Assignee: nobody → pbrosset
Status: NEW → ASSIGNED
Keywords: leave-open
https://hg.mozilla.org/mozilla-central/rev/37d8224ed59c
Status: ASSIGNED → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → Firefox 55
Product: Firefox → DevTools
You need to log in before you can comment on or make changes to this bug.