mirror
/
sitespeed.io
mirror of https://github.com/sitespeedio/sitespeed.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

coach updated docs (#1790)

This commit is contained in:
Peter Hedenskog 2017-11-10 08:44:23 +01:00 committed by GitHub
parent a79040dce8
commit d25e9dfd88
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/documentation/coach/developers/index.md
View File

@ -23,8 +23,8 @@ You need install [Node.js](https://nodejs.org/en/), [npm](https://nodejs.org/en/
When you got them installed you can clone the project (or rather first fork it and clone your fork).
```
$ git clone git@github.com:sitespeedio/coach.git
```bash
git clone git@github.com:sitespeedio/coach.git
```
Inside your coach folder install the dependencies and run the tests to check that everything works:
@ -194,7 +194,7 @@ Each test case runs against a specific HTML page located in `test/http-server` C
## Test your changes against a web page
The coach uses Browsertime as runner for browsers. When you finished with a change, make sure to build a new version of the combined Javascript and then test against a url.
```bash
```
npm run combine
bin/index.js https://www.sitespeed.io firefox
```

2
docs/documentation/coach/index.md
View File

@ -13,7 +13,7 @@ twitterdescription:
<img src="{{site.baseurl}}/img/logos/coach.png" class="pull-right img-big" alt="I'm the coach" width="188" height="219">
The coach helps you find performance problems on your web page. Think of the coach as a modern version of [YSlow](http://yslow.org/). The coach will give advice of how your page could be faster. You can run the coach standalone, include it in your own tool or get the data when you run sitespeed.io. There is even a chrome plugin built by the community [here](https://chrome.google.com/webstore/detail/coach-panel/olecfjmnejnkjipoicfpneceppjeaemo).
The coach helps you find performance problems on your web page. Think of the coach as a modern version of [YSlow](http://yslow.org/). The coach will give advice of how your page could be faster. You can run the coach standalone, include it in your own tool or get the data when you run sitespeed.io.
* [Introduction](introduction/)
* [How to use the coach](how-to/)

1
docs/documentation/coach/introduction/index.md
View File

@ -35,7 +35,6 @@ Ten reasons why we love the coach and you will too:
- The coach is open-source. The advice is public, you can check it, change it, or add to it yourself. Help us make the coach even better!
- The coach can combine knowledge from the DOM with HAR to give you super powerful advice.
- The CLI output is pretty nice. You can configure how much you want to see. Use it as a fast way to check the performance of your page.
- The coach is a part of sitespeed.io 4.0!
## Work in progress!
We know you want the coach to help you, but right now YOU need to help the coach! The coach is new and needs more advice. Send a PR with a new advice, so the coach gets more knowledge! Check out the [issues](https://github.com/sitespeedio/coach/issues), try the project and give us feedback!