Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update user-flow.md to reflect current release #14604

Merged
merged 4 commits into from
Dec 12, 2022

Conversation

ChristopherPHolder
Copy link
Contributor

@ChristopherPHolder ChristopherPHolder commented Dec 11, 2022

Summary

Updating the docs for User Flow to reflect the current release

  • Change flow import path from import lighthouse from 'lighthouse/core/api.js'; to import {startFlow} from 'lighthouse/lighthouse-core/fraggle-rock/api.js';

  • remove startNavigation/endNavigation

  • change interactive navigation with startNavigation/endNavigation to a callback navigation

  • change beginTimepsan to startTimespan

Related Issues/PRs

Closes #14603

- Change flow import path from `import lighthouse from 'lighthouse/core/api.js';` to `import {startFlow} from 'lighthouse/lighthouse-core/fraggle-rock/api.js';`

- remove `startNavigation`/`endNavigation`

- change interactive navigation with `startNavigation`/`endNavigation` to a callback navigation

- change `beginTimepsan` to `startTimespan`
Copy link
Member

@adamraine adamraine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR! This is what I was imagining on main.

docs/user-flows.md Show resolved Hide resolved
docs/user-flows.md Outdated Show resolved Hide resolved
docs/user-flows.md Show resolved Hide resolved
- remove 
- revert timespan to navigation change
Copy link
Contributor Author

@ChristopherPHolder ChristopherPHolder left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@adamraine adamraine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we also remove the reference to (Lighthouse v10) in L3?

Yeah sounds good.

docs/user-flows.md Outdated Show resolved Hide resolved
Co-authored-by: Adam Raine <[email protected]>
@adamraine adamraine merged commit 5aad84d into GoogleChrome:main Dec 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

User Flow docs are not up-to-date?
3 participants