mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-22 09:45:41 +00:00
e76a9c3329
MozReview-Commit-ID: 9RRTngBSF2F Differential Revision: https://phabricator.services.mozilla.com/D13988 --HG-- rename : devtools/docs/README.md => devtools/docs/about-documentation.md rename : devtools/docs/contributing/code-reviews.md => devtools/docs/contributing/code-reviews-checklist.md extra : moz-landing-system : lando
873 B
873 B
About this documentation
This guide is built with MarkDown files and GitBook.
The source code for this documentation is distributed with the source code for the tools, in the docs/
folder.
If you want to contribute to the documentation, clone the repository, make your changes locally, and then regenerate the book to see how it looks like before submitting a patch:
# 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
# You can now navigate to localhost:4000 in your browser to see the output
open http://localhost:4000 # this would work in MacOS
# Or build the book only (this places the output into `docs/_book`)
gitbook build