Skip to content

Commit 5faf11d

Browse files
committed
Simplify by removing building documentation, these docs will be in the /docs folder in the tree as discussed. Moved rest of sections around to better serve the purpose of this as a website with pointers to places.
1 parent 576ed9e commit 5faf11d

File tree

3 files changed

+34
-281
lines changed

3 files changed

+34
-281
lines changed

README.md

Lines changed: 34 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -2,80 +2,24 @@
22

33
These are the tools provided by Firefox for developers to inspect Web code.
44

5-
This repository aims to provide a general overview of [how the tools are built](#working-on-the-code-and-contributing), [who](#people-and-modules) is working on them, and how to [get involved](#getting-in-touch).
6-
7-
If you are looking for user support, there's [a whole area at MDN](https://developer.mozilla.org/en-US/docs/Tools) dedicated to it.
5+
This repository is a hub that points to Developer Tools resources.
86

97
We abide by our [code of conduct](CODE_OF_CONDUCT.md), and expect all contributors to do the same.
108

11-
## Working on the code and contributing
12-
13-
* [Building DevTools](./docs/building.md) will get you from zero to custom build of DevTools you can modify in your computer.
14-
* [Setting up a development profile](./docs/building-development-profile.md) shows how to configure Firefox with the best settings for developing and debugging DevTools.
15-
<!--TODO: * Finding bugs to work on-->
16-
<!--TODO: * Getting your code into DevTools' repository (AKA creating and sending patches) -->
17-
18-
### Bugs and issue trackers
19-
20-
Since we have code in two different places, issues and bugs are to be found in two different places:
21-
22-
* For code in `m-c`: [http://firefox-dev.tools/](http://firefox-dev.tools/) which also lets you filter by good bugs for beginners.
23-
* For code in `devtools-html`: [this page](https://github.com/search?l=&q=org%3Adevtools-html+state%3Aopen&type=Issues) lists all the issues across the organisation and these are [available issues](https://github.com/search?l=&q=org%3Adevtools-html+state%3Aopen+label%3Aavailable&type=Issues) i.e. ready to be worked on.
24-
259
## Documentation
2610

27-
Broadly speaking, the tools are divided in two parts: the server and the client. A **server** is anything that can be debugged: for example, your browser, but it could also be Firefox for Android, running on another device. The **client** is the front-end side of the tools, and it is what developers interact with when using the tools.
28-
29-
Since these two parts are decoupled, we can connect to any server using the same client. This enables us to debug multiple types of servers, using the same protocol to communicate.
30-
31-
You will often hear about `actors`. Each feature that can be debugged (for example, network) is exposed via an `actor`, which provides data about that specific feature. It's up to each server to implement some or all actors; the client needs to find out and decide what it can render on the front-side when it connects to the server. So when we want to debug a new feature, we might need to do work in two parts of the code: the server (perhaps implementing a new actor, or extending existing ones) and the client (to display the debugging data returned by the actor).
32-
33-
Often, an actor will correspond to a panel. But a panel might want to get data from multiple actors.
34-
35-
You might also hear about `the toolbox`. The toolbox is what everyone else calls `developer tools` i.e. the front-end that you see when you open the tools in your browser.
36-
37-
This is just a brief overview. For more detailed documentation:
38-
39-
* There is a [docs](https://dxr.mozilla.org/mozilla-central/source/devtools/docs) folder on `m-c` with technical information about the tools and about each individual panel. We are publishing [an HTML version of these documents](http://firefox-dev.tools/docs/) as well.
40-
* [Internal technical documentation](https://wiki.mozilla.org/DevTools#Internal_Technical_Documentation) (NOTE: we're migrating from here to the folder mentioned above).
41-
* Additionally, check out each GitHub repository for documentation specific to that repository or module.
11+
* [End user guides](https://developer.mozilla.org/en-US/docs/Tools).
12+
* [Developers](https://dxr.mozilla.org/mozilla-central/source/devtools/docs/) documentation - here's [an HTML version of these documents](http://firefox-dev.tools/docs/) as well.
4213
* Not strictly a roadmap, but these are [some of our 2017 goals](https://groups.google.com/forum/#!topic/mozilla.dev.developer-tools/e-WTOb1U8Sc).
4314

44-
## People and modules
45-
46-
The tools are broadly divided into panels. Each panel has one or more owners, who mostly work(s) on that panel and are the best people to ask if you have specific questions about the code.
47-
48-
* about:debugging: jdescottes, ochameau
49-
* Animation Inspector: gl, pbro, daisuke
50-
* Canvas Debugger: `<unmaintained>`
51-
* Console: bgrins, nchevobbe
52-
* Debugger: jlast
53-
* Developer Toolbar: jwalker, mikeratcliffe
54-
* DOM: honza
55-
* Framework: Browser integration, toolbox and test infrastructure: jryans, bgrins, ochameau, honza
56-
* Inspector: gl, pbro, zer0, jdescottes, tromey
57-
* JSON Viewer: honza
58-
* Memory: gregtatum
59-
* Network Monitor: honza, rickychien, gasolin
60-
* Performance: gregtatum
61-
* Remote protocol and server infrastructure: jryans, ochameau
62-
* Responsive Design Mode: jryans, zer0
63-
* Scratchpad: jdescottes
64-
* Shader Editor: `<unmaintained>`
65-
* Style Editor: gl
66-
* Storage Inspector: mikeratcliffe
67-
* Themes: bgrins, ntim
68-
* Web Audio Editor: `<unmaintained>`
69-
* WebIDE: jryans, ochameau
70-
7115
## News and demos
7216

7317
We publish news and updates to two blogs:
7418

7519
* [Nightly](https://blog.nightly.mozilla.org/tag/devtools/) for features newly added to Firefox Nightly. This is the place to request feedback from early adopters!
7620
* [Hacks](https://hacks.mozilla.org/category/developer-tools/) when features reach more stable versions of Firefox.
7721

78-
You're more than encouraged to help us talk about the tools by writing an article, making a demo, or both! We also wrote [some guidelines for making demos](https://github.com/devtools-html/devtools-demos).
22+
You're more than encouraged to help us talk about the tools by writing an article, making a demo, or both! We wrote [some guidelines for making demos](https://github.com/devtools-html/devtools-demos).
7923

8024
## Getting in touch
8125

@@ -86,7 +30,7 @@ There are various ways to get in touch with us:
8630
* or under each repository in [devtools-html](https://github.com/devtools-html) for code in GitHub
8731
* The [DevTools forum](https://discourse.mozilla-community.org/c/devtools) is a great way to get in touch with us and also ensure that your question is visible to other people (and hopefully help them as well).
8832
* [Mailing list](https://groups.google.com/forum/#!forum/mozilla.dev.developer-tools): for people who prefer mail to forums.
89-
* Team weekly video call: [Vidyo room DevTools](https://v.mozilla.com/flex.html?roomdirect.html&key=n9vJUD3L1vRMHKQC5OCNRT3UBjw), Tuesdays 9AM Pacific time.
33+
* Team weekly video call: [Vidyo room DevTools](https://v.mozilla.com/flex.html?roomdirect.html&key=n9vJUD3L1vRMHKQC5OCNRT3UBjw), Tuesdays 9AM Pacific time. The [meeting doc](https://docs.google.com/document/d/1pUx9xq6L7bonSrDpyUNTQkQxTxAsULLu4kkHZLMEq6w/edit) has more details.
9034
* IRC chat: `#devtools` channel in `irc.mozilla.org`, but bear in mind that perhaps the person that could help you best is not online when you ask the question. For that reason, it might be better to use the forum or mailing list instead.
9135
* Contributors to `debugger.html` also hold [periodic hangouts and have a slack channel](https://github.com/devtools-html/debugger.html#discussion).
9236
* Twitter: [@FirefoxDevTools](https://twitter.com/FirefoxDevTools).
@@ -116,3 +60,32 @@ For substantial changes, we ask that a "request for comment" (RFC) document is p
11660
</a>
11761
{% endfor %}
11862
</div>
63+
64+
### People and modules
65+
66+
The tools are broadly divided into panels. Each panel has one or more owners, who mostly work(s) on that panel and are the best people to ask if you have specific questions about the code.
67+
68+
* about:debugging: jdescottes, ochameau
69+
* Animation Inspector: gl, pbro, daisuke
70+
* Canvas Debugger: `<unmaintained>`
71+
* Console: bgrins, nchevobbe
72+
* Debugger: jlast
73+
* Developer Toolbar: jwalker, mikeratcliffe
74+
* DOM: honza
75+
* Framework: Browser integration, toolbox and test infrastructure: jryans, bgrins, ochameau, honza
76+
* Inspector: gl, pbro, zer0, jdescottes, tromey
77+
* JSON Viewer: honza
78+
* Memory: gregtatum
79+
* Network Monitor: honza, rickychien, gasolin
80+
* Performance: gregtatum
81+
* Remote protocol and server infrastructure: jryans, ochameau
82+
* Responsive Design Mode: jryans, zer0
83+
* Scratchpad: jdescottes
84+
* Shader Editor: `<unmaintained>`
85+
* Style Editor: gl
86+
* Storage Inspector: mikeratcliffe
87+
* Themes: bgrins, ntim
88+
* Web Audio Editor: `<unmaintained>`
89+
* WebIDE: jryans, ochameau
90+
91+

docs/building-development-profile.md

Lines changed: 0 additions & 81 deletions
This file was deleted.

docs/building.md

Lines changed: 0 additions & 139 deletions
This file was deleted.

0 commit comments

Comments
 (0)