Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Version the Lighthouse docs #1637

Closed
kaycebasques opened this issue Oct 9, 2019 · 1 comment
Closed

Version the Lighthouse docs #1637

kaycebasques opened this issue Oct 9, 2019 · 1 comment

Comments

@kaycebasques
Copy link
Contributor

kaycebasques commented 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:

image

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.
@kaycebasques 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 kaycebasques changed the title Figure out Lighthouse documentation versioning Figure out Lighthouse versioning Oct 9, 2019
@kaycebasques kaycebasques changed the title Figure out Lighthouse versioning Version the Lighthouse docs Oct 9, 2019
@kaycebasques kaycebasques added the content Issues related to content label Dec 18, 2019
@carolrivero carolrivero added new content for new content requests and removed content Issues related to content labels Mar 13, 2020
@kaycebasques kaycebasques removed the new content for new content requests label Apr 11, 2020
@kaycebasques
Copy link
Contributor Author

This was more of a speculative idea. I don't think this work is actually going to happen.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants