You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Mar 14, 2024. It is now read-only.
All of the Lighthouse versions point to the same docs on web.dev. If we include screenshots of the Lighthouse report UI, or if we mention that Lighthouse measures a certain number of metrics, then the doc will appear outdated to some Lighthouse users. The metrics might be in a different order, or the metrics might be different altogether. The implementations of the metrics change over time, too. This problem might apply to the rest of the audit documentation, but the problem is most visible in the metrics documentation.
Example of current UI:
Options
Continue using one document per audit or metric, but add historical information to each document. Examples:
Mention what version of Lighthouse the screenshot was taken in and mention that if users are on a different version the UI will look different.
Add a Changelog section explaining how a metric or audit has changed over time.
Create a versioning infrastructure to serve a different document depending on what Lighthouse version the user is running. A lot of the content will be the same so we'll need a good DRY infrastructure.
The text was updated successfully, but these errors were encountered:
kaycebasques
changed the title
Remove screenshots and mentions of a specific number of metrics from the metrics docs
Figure out Lighthouse documentation versioning
Oct 9, 2019
kaycebasques
changed the title
Figure out Lighthouse documentation versioning
Figure out Lighthouse versioning
Oct 9, 2019
kaycebasques
changed the title
Figure out Lighthouse versioning
Version the Lighthouse docs
Oct 9, 2019
Context
Problem
All of the Lighthouse versions point to the same docs on web.dev. If we include screenshots of the Lighthouse report UI, or if we mention that Lighthouse measures a certain number of metrics, then the doc will appear outdated to some Lighthouse users. The metrics might be in a different order, or the metrics might be different altogether. The implementations of the metrics change over time, too. This problem might apply to the rest of the audit documentation, but the problem is most visible in the metrics documentation.
Example of current UI:
Options
Changelog
section explaining how a metric or audit has changed over time.The text was updated successfully, but these errors were encountered: