Bug 1349256 - Moved docs into folders so it's easier to browse; r=sole
MozReview-Commit-ID: HzL3w8vp8iS
--- a/devtools/docs/SUMMARY.md
+++ b/devtools/docs/SUMMARY.md
@@ -1,22 +1,23 @@
# Summary
-* [Tool Architectures](tools.md)
- * [Inspector](inspector.md)
- * [Panel Architecture](inspector-panel.md)
- * [Highlighters](highlighters.md)
- * [Memory](memory-panel.md)
- * [Debugger](debugger-panel.md)
- * [Responsive Design Mode](responsive-design-mode.md)
-* [Frontend](frontend.md)
- * [Panel SVGs](svgs.md)
- * [React](react.md)
- * [Guidelines](react-guidelines.md)
- * [Tips](react-tips.md)
- * [Redux](redux.md)
- * [Guidelines](redux-guidelines.md)
- * [Tips](redux-tips.md)
-* [Backend](backend.md)
- * [Protocol](protocol.md)
- * [Debugger API](debugger-api.md)
- * [Backward Compatibility](backward-compatibility.md)
+* [Tool Architectures](tools/tools.md)
+ * [Inspector](tools/inspector.md)
+ * [Panel Architecture](tools/inspector-panel.md)
+ * [Highlighters](tools/highlighters.md)
+ * [Memory](tools/memory-panel.md)
+ * [Debugger](tools/debugger-panel.md)
+ * [Responsive Design Mode](tools/responsive-design-mode.md)
+ * [HTTP Inspector](tools/http-inspector.md)
+* [Frontend](frontend/frontend.md)
+ * [Panel SVGs](frontend/svgs.md)
+ * [React](frontend/react.md)
+ * [Guidelines](frontend/react-guidelines.md)
+ * [Tips](frontend/react-tips.md)
+ * [Redux](frontend/redux.md)
+ * [Guidelines](frontend/redux-guidelines.md)
+ * [Tips](frontend/redux-tips.md)
+* [Backend](backend/backend.md)
+ * [Protocol](backend/protocol.md)
+ * [Debugger API](backend/debugger-api.md)
+ * [Backward Compatibility](backend/backward-compatibility.md)
rename from devtools/docs/backend.md
rename to devtools/docs/backend/backend.md
rename from devtools/docs/backward-compatibility.md
rename to devtools/docs/backend/backward-compatibility.md
rename from devtools/docs/debugger-api.md
rename to devtools/docs/backend/debugger-api.md
rename from devtools/docs/protocol.md
rename to devtools/docs/backend/protocol.md
rename from devtools/docs/frontend.md
rename to devtools/docs/frontend/frontend.md
rename from devtools/docs/react-guidelines.md
rename to devtools/docs/frontend/react-guidelines.md
rename from devtools/docs/react-tips.md
rename to devtools/docs/frontend/react-tips.md
rename from devtools/docs/react.md
rename to devtools/docs/frontend/react.md
rename from devtools/docs/redux-guidelines.md
rename to devtools/docs/frontend/redux-guidelines.md
rename from devtools/docs/redux-tips.md
rename to devtools/docs/frontend/redux-tips.md
rename from devtools/docs/redux.md
rename to devtools/docs/frontend/redux.md
rename from devtools/docs/svgs.md
rename to devtools/docs/frontend/svgs.md
--- a/devtools/docs/svgs.md
+++ b/devtools/docs/frontend/svgs.md
@@ -19,24 +19,24 @@ For Illustrator you'll want the followin
You can get a more detailed breakdown with images [here](http://medialoot.com/blog/3-valuable-pixel-perfect-illustrator-techniques/).
You can download a sample Illustrator file [here](https://www.dropbox.com/home/Mozilla_MobileUX_Share/Internal%20Assets/Templates/Firefox?preview=pixel-grid-illustrator.ai).
### Tips for Object Creation
When you're designing your icons in a graphics editor like Adobe Illustrator, there are a lot of things you can do that will bring down the size of the file and make your SVGs easier for the developers to work with. Here are some of them:
- **Expand paths**: Instead of having multiple shapes overlapping each other, expand shapes using the pathfinder.
-![Use pathfinder to expand shapes](./svgs/pathfinder.gif)
+![Use pathfinder to expand shapes](../resources/pathfinder.gif)
- Simplify paths (```Object``` > ```Path``` > ```Simplify```)
- Expand objects so that strokes become objects. This has the added benefit of keeping the stroke size intact as the SVG is resized.
-![Expand strokes to make them objects](./svgs/expand-strokes.gif)
+![Expand strokes to make them objects](../resources/expand-strokes.gif)
## Sketch
Sketch vector work is a little different but the fundamentals (keeping your SVG small, expanding all paths) is the same. Here's what we've found helps to build clean icons:
- **Build your icon at 16x16 with the Pixel Grid turned on.** You can turn the pixel grid on at ```View > Canvas > Show Pixels```
- **Make sure that all x/y coordinates are full pixels for lines/rectangles.** Sub-pixels = not on pixel grid.
-![Position in the upper right hand corner of Sketch](./svgs/sketch-position.png)
+![Position in the upper right hand corner of Sketch](../resources/sketch-position.png)
- **Expand all your paths so strokes expand properly as the SVG gets resized.** You can do this at ```Layer > Paths > Vectorize Stroke```.
- **Align anything that isn't boxy to the pixel grid with item selected then ```Layer > Round to Nearest Pixel Edge```.**
\ No newline at end of file
rename from devtools/docs/img/box-model-highlighter-screenshot.png
rename to devtools/docs/resources/box-model-highlighter-screenshot.png
rename from devtools/docs/svgs/expand-strokes.gif
rename to devtools/docs/resources/expand-strokes.gif
rename from devtools/docs/svgs/pathfinder.gif
rename to devtools/docs/resources/pathfinder.gif
rename from devtools/docs/svgs/sketch-position.png
rename to devtools/docs/resources/sketch-position.png
rename from devtools/docs/debugger-panel.md
rename to devtools/docs/tools/debugger-panel.md
rename from devtools/docs/highlighters.md
rename to devtools/docs/tools/highlighters.md
--- a/devtools/docs/highlighters.md
+++ b/devtools/docs/tools/highlighters.md
@@ -1,17 +1,17 @@
# Highlighters
This article provides technical documentation about DevTools highlighters.
By highlighter, we mean anything that DevTools displays on top of the content page, in order to highlight an element, a set of elements or shapes to users.
The most obvious form of highlighter is the box-model highlighter, whose job is to display the 4 box-model regions on top of a given element in the content page, as illustrated in the following screen capture:
-![Box-model highlighter](./img/box-model-highlighter-screenshot.png)
+![Box-model highlighter](../resources/box-model-highlighter-screenshot.png)
But there can be a wide variety of highlighters. In particular, highlighters are a pretty good way to give detailed information about:
* the exact form of a css shape,
* how a css transform applied to an element,
* where are the color stops of a css gradient,
* which are all the elements that match a given selector,
* ...
rename from devtools/docs/http-inspector.md
rename to devtools/docs/tools/http-inspector.md
rename from devtools/docs/inspector-panel.md
rename to devtools/docs/tools/inspector-panel.md
rename from devtools/docs/inspector.md
rename to devtools/docs/tools/inspector.md
rename from devtools/docs/memory-panel.md
rename to devtools/docs/tools/memory-panel.md
rename from devtools/docs/responsive-design-mode.md
rename to devtools/docs/tools/responsive-design-mode.md
rename from devtools/docs/tools.md
rename to devtools/docs/tools/tools.md
--- a/devtools/moz.build
+++ b/devtools/moz.build
@@ -19,28 +19,28 @@ DIRS += [
# /browser uses DIST_SUBDIR. We opt-in to this treatment when building
# DevTools for the browser to keep the root omni.ja slim for use by external XUL
# apps. Mulet also uses this since it includes /browser.
if CONFIG['MOZ_BUILD_APP'] in ('browser', 'b2g/dev'):
DIST_SUBDIR = 'browser'
export('DIST_SUBDIR')
-with Files('**'):
- BUG_COMPONENT = ('Firefox', 'Developer Tools')
-
-with Files('docs/**'):
- BUG_COMPONENT = ('Firefox', 'Developer Tools')
-
-with Files('docs/memory-panel.md'):
- BUG_COMPONENT = ('Firefox', 'Developer Tools: Memory')
-
-with Files('docs/debugger-panel.md'):
- BUG_COMPONENT = ('Firefox', 'Developer Tools: Debugger')
-
-with Files('docs/debugger-api.md'):
- BUG_COMPONENT = ('Firefox', 'Developer Tools: Debugger')
-
-with Files('docs/http-inspector.md'):
- BUG_COMPONENT = ('Firefox', 'Developer Tools: Console')
-
-with Files('docs/inspector-panel.md'):
- BUG_COMPONENT = ('Firefox', 'Developer Tools: Inspector')
+with Files('**'):
+ BUG_COMPONENT = ('Firefox', 'Developer Tools')
+
+with Files('docs/**'):
+ BUG_COMPONENT = ('Firefox', 'Developer Tools')
+
+with Files('docs/tools/memory-panel.md'):
+ BUG_COMPONENT = ('Firefox', 'Developer Tools: Memory')
+
+with Files('docs/tools/debugger-panel.md'):
+ BUG_COMPONENT = ('Firefox', 'Developer Tools: Debugger')
+
+with Files('docs/backend/debugger-api.md'):
+ BUG_COMPONENT = ('Firefox', 'Developer Tools: Debugger')
+
+with Files('docs/tools/http-inspector.md'):
+ BUG_COMPONENT = ('Firefox', 'Developer Tools: Console')
+
+with Files('docs/tools/inspector-panel.md'):
+ BUG_COMPONENT = ('Firefox', 'Developer Tools: Inspector')