GoogleChrome / GoogleChrome/lighthouse
Add documentation about configuring audit options
Open
docs
P2
- Dominant language
- JavaScript
- Stars
- 30.8k
- Forks
- 9.8k
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 20
Description
We don't have any docs on how to configure the options of an audit in a config.
ex:
```js
{
extends: 'default',
audits: [
{path: 'screenshot-thumbnails', options: {numberOfThumbnails: 10}},
],
}
```
Contributor guide
Research direction
Start by locating Lighthouse's existing documentation for configuration and audits; the issue provides the relevant config shape and an options example. Document how audit options are configured, including the shown screenshot-thumbnails example. Done means users can find clear guidance for configuring audit options in a config.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100