Architecture docs: add arch diagram and lingo updates #2158
Conversation
docs/architecture.md
Outdated
| * **Gatherers** - Requests data from the browser or collects information from the page (and maybe post-processing) | ||
| * **Artifacts** - output of a gatherer | ||
| * **Audits** - Tests for something. Either a pass/fail check or calculates a score. | ||
| * **Categories** - Grouping audit results into a user-facing section of the report (eg. `Best Practices`). Appies weighting and overall scoring to the section. |
|
|
||
| * **Driver** - Interfaces with [Chrome Debugging Protocol](https://developer.chrome.com/devtools/docs/debugger-protocol) ([API viewer](https://chromedevtools.github.io/debugger-protocol-viewer/)) |
There was a problem hiding this comment.
nuke the API viewer link since these two things now redirect to the same place
docs/architecture.md
Outdated
|
|
||
| `npm install -g js-vd; vd --exclude "node_modules|third_party|fs|path|url|log" lighthouse-core/ > graph.html` | ||
| * **Driver** - Interfaces with [Chrome Debugging Protocol](https://developer.chrome.com/devtools/docs/debugger-protocol) ([API viewer](https://chromedevtools.github.io/debugger-protocol-viewer/)) | ||
| * **Gatherers** - Requests data from the browser or collects information from the page (and maybe post-processing) |
There was a problem hiding this comment.
Requests data from the browser or collects information from the page
is there another way to phrase this? (collecting information from the page is also data requested from the browser). Should it mention that it's collected via the driver?
There was a problem hiding this comment.
Requests data from the browser, via the driver. Minimal post-processing.
There was a problem hiding this comment.
"Uses Driver to collect information about the page. Minimal post-processing."
docs/architecture.md
Outdated
| * **Driver** - Interfaces with [Chrome Debugging Protocol](https://developer.chrome.com/devtools/docs/debugger-protocol) ([API viewer](https://chromedevtools.github.io/debugger-protocol-viewer/)) | ||
| * **Gatherers** - Requests data from the browser or collects information from the page (and maybe post-processing) | ||
| * **Artifacts** - output of a gatherer | ||
| * **Audits** - Tests for something. Either a pass/fail check or calculates a score. |
There was a problem hiding this comment.
"Tests for something using the artifacts as inputs" or something?
There was a problem hiding this comment.
Using the artifacts as input, the audits do core evaluation and pass/fail/scoring.
let's also add this guy.. (probably as a sub-bullet to audits?):
- Computed Artifacts - Generated on-demand from artifacts, these add additional meaning, and are often shared amongst multiple audits.
There was a problem hiding this comment.
"Using the Artifacts as input, Audits evaluate a test and assign pass/fail/scoring."
Done
|
|
No description provided.