dfd489427a
Mobile emulation table |
||
---|---|---|
css | ||
docs | ||
images | ||
pillar-images | ||
.gitignore | ||
_book.yaml | ||
_redirects.yaml | ||
index.html | ||
pillar.html | ||
readme.md | ||
redirects.json |
readme.md
The Chrome DevTools documentation
This is the source of the official DevTools documentation.
Contributing
We regularly update the docs and welcome any contributions or bug-fixes.
Before submitting a pull request, please open a new issue to let us know you're working on.
This will allow us to provide feedback and coordinate contribution efforts.
FYI The extension docs live in the chromium repo: chromium/src/chrome/common/extensions/docs
Orientation
- ./docs
- Contains all the working files.
- ./index.html
- Contains the project overview page.
- ./images
- Contains images for index.html.
- ./_book.yaml
- Contains the titles and paths of individual docs.
- ./_redirect.yaml
- Contains redirects from one location to another.
Additional DevTools docs
Covered in the DevTools Content Inventory
Running the site
- In the root of the project, start a [server] (
3fa2e7dc1f/.functions (L25-L32)
).
- It's easier if your server can also do a directory listing.
- Open http://localhost:8000/docs/_preview.html
- You will see the boilerplate along with a directory listing
- Click one of them.
- It should bring you to a url like http://localhost:8000/docs/_preview.html?settings.html
Deployment
Paul or Addy does the work of pushing this stuff live.
- check last commit in google3 via
git log
, get the SHA - pull in latest from GH
- g4 add/edit changed things
- look for changed items by
find . -type f -perm 0640
- compare URL from last commit to master:
github.com/GoogleChrome/devtools-docs/compare/<SHA>...master
, Files Changed, Show Diff Stats
- look for changed items by
- check git status and p4 status
- g4 change, imgsquish, g4 mail
- commit any changed images back to GH
Troublshooting
- Make sure you've created CLs with any imported GH changes.
devsite publish
all relevant files.
License
Except as otherwise noted, the content of the DevTools documentation is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License.