lighthouse
lighthouse copied to clipboard
GoogleChrome
[SEO Audits] Write documentation
Some SEO audits point to existing support documentation and other external sources. We want to have documentation of all of Lighthouse’s audits in one canonical place (d.g.co/tools/lighthouse or jsdoc). Additionally, we should use these LH-specific docs to describe the exact pass/fail conditions for each audit and guidance on how to fix common failure reasons.
@kaycebasques, feel free to work with @kdzwinel on any implementation details of the audits and reach out to Lizzi for peer reviews.
Documentation checklist:
- [x] Document has a
<title> - [x] Images have
alttext - [x] Has a
<meta viewport> - [x] Page has successful HTTP status code
- [x] Document has a
<meta description> - [x] Document has a valid
hreflangcode - [x] Document has a
rel=canonical - [x] Anchors have descriptive text
- [x] Avoids plugins
- [x] Document uses legible font sizes
- [x] Page is not blocked from indexing
- [x] robots.txt is valid
- [x] Tap targets are sized appropriately
- [ ] JSON-LD structured data is valid
This list will be updated as we add more SEO audits.
@kaycebasques I see there were PRs to add docs for the legible text and descriptive anchors audits. Have these audits' descriptions also been updated to point to the new docs? Just trying to get a sense of progress on this issue.
@kaycebasques looking at the checklist in the first comment, there are two items unchecked:
The robots.txt audit is done and ready for docs. Are you able to work on this?
@kdzwinel is still working on the tap targets audit but we'll also need docs for that when ready.
Thanks! FYI I also added a checkbox for the JSON-LD audit which is also in progress. If you have time, we can start on these docs as well, but we'd need to delay publishing them until their respective audits are released.
@kaycebasques we have two new audits that are nearing completion: tap targets and structured data. You can sync with @mattzeunert on the functionality of the audits to be described in the docs.
For the SD audit, it's important to note that we're only testing the JSON-LD flavor of SD and even still we're only doing basic validation to catch the lowest hanging fruit. Manual validation in the SDTT is still recommended.
@mfriesenhahn should #9537 close this? Does web.dev have full coverage of all the bullet points above?
@mfriesenhahn should #9537 close this? Does web.dev have full coverage of all the bullet points above?
Yep, web.dev has a doc for each bullet. #9537 takes care of most of them, with the following exceptions:
- #9084 includes "Document has a
<title>" and "Images havealttext." - #9539 includes "Has a
<meta viewport>."
I'm still tidying up the web.dev docs to address feedback from the Lighthouse team, but I expect to have the SEO ones done in the next day or two.
