devtools-docs/readme.md

1.8 KiB

The Chrome DevTools documentation

This is 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.

Orientation

./docs
Contains all the working files.
./index.html
Contains the project overview page.
./_book.yaml
Contains the titles and paths of individual docs.
./_redirect.yaml
Contains redirects from one location to another.

Running the site

  1. 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.
  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.

Deployment

Paul or Addy does the work of pushing this stuff live.