Repository navigation
docs: document the setup with Lighthouse and with user-flow - #20
Merged
Merged
Conversation
The Usage page set the package up with Lighthouse and mentioned user-flow in a short section. Each setup now has its own page, from install to report. The introduction links to both, and reading the result has its own page since it applies to both. The old Usage URL redirects to the Lighthouse page. Closes #19
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 #19
The docs site had one Usage page that set the package up with Lighthouse and mentioned user-flow in a short section at the end. Each setup now has its own page.
Pages
/docs/getting-started/lighthouse): install, the flow script, how to run it. This is the old Usage page without the user-flow and result sections./docs/getting-started/user-flow): install,.user-flowrc.json, the flow file,npx user-flow collectand the settings for every flow. It links to the user-flow docs for recordings and the rest of the CLI./docs/guides/results): the result section of the old Usage page, since it applies to both setups.Also
/docs/getting-started/usageredirects to the Lighthouse page.Could not find Chrome: npm 11 and pnpm skip Puppeteer's install script, so Chrome isn't downloaded on install.Tested
I ran the code of both pages against the e2e fixture app, each in a fresh project installed with the command of its page:
node flow.mjs: a page load and two soft navigations, no audit errors or run warnings.npx user-flow collectwith the.user-flowrc.jsonand flow file of the page: the same three steps.throttlingMethodin.user-flowrc.json: every step runs with DevTools throttling.pnpm nx run-many -t lint typecheck build -p docspasses.