Repository navigation
docs: cut the docs site down to what soft navigations add - #18
Merged
Merged
Conversation
Four pages: introduction, usage, throttling, and limits. The API, internals, upstreaming and links pages go, along with most of the landing page. The upstreaming plan moves back to docs/upstreaming-to-lighthouse.md.
- The usage example launches the browser and writes the report. - Pages without a table of contents keep the same text width. - A page that starts with a heading no longer shows two rules. - The landing page lists the four pages and drops the second call to action. - The troubleshooting table covers user-flow dry runs.
- The mark, favicon, touch icon and 404 scene are the user-flow ones. - The hero shows the config and a soft navigation step, not a terminal with sample output.
A soft navigation starts from a loaded page, so the hero example failed as written. The usage page and the troubleshooting table say so too.
The hero animation runs the same two-step flow twice: on stock Lighthouse the soft navigation step fails with NO_FCP, with the config it gets FCP, LCP and a score. It replaces the mock browser, which showed a soft navigation but not what the package does.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #17
The site now only covers what the package adds.
4 pages, down from 12:
simulatedoesn't work, per step vs. per flowRemoved: the API reference, How it works, the three Upstreaming pages and Links. From the landing page: the four-step strip, the sample report, the benefit cards and the second call to action. The landing page keeps the hero and one card per page.
Also changed:
NO_FCP, and with the config it gets FCP, LCP and a score. It replaces the mock browser, which showed a soft navigation but not what the package does.The upstreaming plan goes back to
docs/upstreaming-to-lighthouse.md, and both READMEs link to it again.Build, typecheck, lint and format pass. The production build prerenders 7 routes.
Screenshots
Hero animation
Landing page
Doc pages
404 page
Mobile