Bug 1349256 - Added docs about how to generate the gitbook; r=sole draft
authorPatrick Brosset <pbrosset@mozilla.com>
Tue, 21 Mar 2017 15:19:20 +0100
changeset 502979 dc5b2d51990bf7cfd0bf56241b69189598b9b9c6
parent 502978 96dfbd86b0294a041e0fc82158b1d91a8e9ba9e8
child 502980 b9dbd12aacb115b6e8e1e1f2c1e4ee12e052d572
push id50437
push userbmo:pbrosset@mozilla.com
push dateWed, 22 Mar 2017 14:55:57 +0000
reviewerssole
bugs1349256
milestone55.0a1
Bug 1349256 - Added docs about how to generate the gitbook; r=sole MozReview-Commit-ID: 9pa0rXaLehZ
devtools/docs/README.md
--- a/devtools/docs/README.md
+++ b/devtools/docs/README.md
@@ -1,9 +1,24 @@
 # Firefox Developer Tools
 
 Hello! This documentation is for developers who want to work on the developer tools.
 
 If you are looking for general docs about how to use the tools, checkout [this MDN page](https://developer.mozilla.org/en-US/docs/Tools) instead.
 
 If you are looking for a getting started guide on the developer tools, all of this information is documented on the [Hacking](https://wiki.mozilla.org/DevTools/Hacking) wiki page.
 
-Head over to the [table of contents](SUMMARY.md) to browse the documentation.
\ No newline at end of file
+[GitBook](https://github.com/GitbookIO/gitbook) is used to generate online documentation from the markdown files here.
+Here is how you can re-generate the book:
+
+```bash
+# Install GitBook locally
+npm install -g gitbook-cli
+
+# Go into the docs directory
+cd /path/to/mozilla-central/devtools/docs/
+
+# Generate the docs and start a local server
+gitbook serve
+
+# Or just built the book
+gitbook build
+```
\ No newline at end of file