Skip to content

pearlchen-old/devtools-docs

 
 

Repository files navigation

The Chrome DevTools documentation

This is the source of the official DevTools documentation on developer.chrome.com (aka "DCC").

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

  1. In the root of the project, start a [server] (https://github.com/paulirish/dotfiles/blob/3fa2e7dc1f1ea5eaf7f6a2531b937ff8bd8833f9/.functions#L25-L32).
  • It's easier if your server can also do a directory listing.
  1. Open http://localhost:8000/docs/_preview.html
  2. You will see the boilerplate along with a directory listing image
  3. Click one of them.
  4. It should bring you to a url like http://localhost:8000/docs/_preview.html?settings.html
  • you can navigate to this directly if you like
  • it looks like this image
  • Things mostly work but is not exactly the same as viewing through DCC.

Deployment

Once pushed to master, updates will go live to the DCC site within a few minutes or so.

Troublshooting

  • Make sure you've created CLs with any imported GH changes.
  • If you can't find the content with the devtools-docs repo, it might be part of the Chromium repo
    • CSS, JavaScript, and navigation bugs related to developer.chrome.com can be logged to the Chromium issue tracker

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.

About

The documentation for Chrome DevTools

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 81.4%
  • CSS 18.6%