docs: update docs for v3 #5357
Merged
docs: update docs for v3 #5357
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
patrickhulce
requested review from
paulirish and
vinamratasingal-zz
as code owners
brendankenny
approved these changes
May 25, 2018
| @@ -84,6 +84,6 @@ Tracing processor takes the output of trace of tab and identifies the top-level | |||
|
|
|||
| ## Audits | |||
|
|
|||
| The return value of each audit [takes this shape](https://github.com/GoogleChrome/lighthouse/blob/b354890076f2c077c5460b2fa56ded546cca72ee/lighthouse-core/closure/typedefs/AuditResult.js#L23-L55). | |||
| The return value of each audit [takes this shape](https://github.com/GoogleChrome/lighthouse/blob/8f500e00243e07ef0a80b39334bedcc8ddc8d3d0/typings/audit.d.ts#L117-L130). | |||
There was a problem hiding this comment.
nice catch, didn't even think to search for these.... :(
docs/puppeteer.md
Outdated
| port: (new URL(browser.wsEndpoint())).port, | ||
| output: 'json', | ||
| logLevel: 'info', | ||
| }); | ||
| })).lhr; |
There was a problem hiding this comment.
would destructuring style const {lhr} = await lighthouse... read slightly better?
There was a problem hiding this comment.
ooo yeah much better 👍
| | `configPath` | Ignored, pass the config in as the 3rd argument to `lighthouse`. | | ||
| | `preset` | Ignored, pass the config in as the 3rd argument to `lighthouse`. | | ||
| | `verbose` | Ignored, use `logLevel` instead. | | ||
| | `quiet` | Ignored, use `logLevel` instead. | |
There was a problem hiding this comment.
this is a great new section
docs/readme.md
Outdated
| ``` | ||
|
|
||
| You can also craft your own config (e.g. [mixed-content-config.js](https://github.com/GoogleChrome/lighthouse/blob/master/lighthouse-core/config/mixed-content-config.js)) for custom runs. Also see the [basic custom audit recipe](https://github.com/GoogleChrome/lighthouse/tree/master/docs/recipes/custom-audit). | ||
|
|
||
| ### A warning about flags |
There was a problem hiding this comment.
maybe a less ominous title for the section? :) Just ### CLI flags that have no effect as module options or something better than that
There was a problem hiding this comment.
went with "Differences from CLI flags"
docs/scoring.md
Outdated
| @@ -6,7 +6,7 @@ Note 1: if you want a **nice spreadsheet** version of this doc to understand wei | |||
|  | |||
| *Screenshot of the [scoring spreadsheet](https://docs.google.com/spreadsheets/d/1Cxzhy5ecqJCucdf1M0iOzM8mIxNc7mmx107o5nj38Eo/edit#gid=0)* | |||
|
|
|||
| Note 2: if you receive a **score of 0** in any Lighthouse category, that usually indicates an error on our part. Please file an [issue](https://github.com/GoogleChrome/lighthouse/issues) so our team can look into it. | |||
| Note 2: if you receive a **score of ?** in any Lighthouse category, that indicates an error. Please file an [issue](https://github.com/GoogleChrome/lighthouse/issues) so our team can look into it. | |||
There was a problem hiding this comment.
indicates an error occurred, maybe?
docs/throttling.md
Outdated
|
|
||
| ## Throttling basics | ||
|
|
||
| 1. The DevTools network throttling, which Lighthouse uses, is implemented within Chrome at the _request-level_. As a result, it has some downsides that are now summarized in this doc: [Network Throttling & Chrome - status](https://docs.google.com/document/d/1TwWLaLAfnBfbk5_ZzpGXegPapCIfyzT4MWuZgspKUAQ/edit). The TLDR: while it's a [decent approximation](https://docs.google.com/document/d/1uS9SH1KpVH31JAmf-iIZ61VazwAF9MrCVwETshBC4UQ/edit), it's not a sufficient model of a slow connection. The [multipliers used in Lighthouse](https://github.com/GoogleChrome/lighthouse/blob/3be483287a530fb560c843b7299ef9cfe91ce1cc/lighthouse-core/lib/emulation.js#L33-L39) attempt to correct for the differences. | ||
| 1. Simulated throttling, which Lighthouse uses by default, is computed throttling _after a trace as been recorded_ which makes it very fast and deterministic. However, due to the imperfect nature of predicting alternate execution paths, there is inherrent inaccuracy that is summarized in this doc: [Lighthouse Metric Variability and Accuracy](https://docs.google.com/document/d/1BqtL-nG53rxWOI5RO0pItSRPowZVnYJ_gBEQCJ5EeUE/edit). The TLDR: while it's roughly as accurate or better than DevTools throttling for most sites, it suffers from edge cases and a deep investigation to performance should use _Packet-level_ throttling tools. |
There was a problem hiding this comment.
as been -> has been
inherrent -> inherent
| ## import your report renderer into devtools-frontend and run devtools closure compiler | ||
| yarn compile-devtools | ||
| ## run tsc compiler | ||
| yarn type-check |
There was a problem hiding this comment.
mind also updating the mention of "closure annotations" in CONTRIBUTING.md too? Can link to https://github.com/Microsoft/TypeScript/wiki/JSDoc-support-in-JavaScript instead of that closure link
AZZAELSAYED
reviewed
Jun 10, 2018
| @@ -84,6 +84,6 @@ Tracing processor takes the output of trace of tab and identifies the top-level | |||
|
|
|||
| ## Audits | |||
|
|
|||
| The return value of each audit [takes this shape](https://github.com/GoogleChrome/lighthouse/blob/b354890076f2c077c5460b2fa56ded546cca72ee/lighthouse-core/closure/typedefs/AuditResult.js#L23-L55). | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
updates lots of docs for v3 changes
Related Issues/PRs
closes #5355
closes #3587