docs: add a soft navigations integration page

Open Beginner friendly
#356 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
66/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
devtools
Domain
documentation

Research direction

The payload names no file path, so start by finding where the project keeps its existing docs pages and how they are linked in navigation, then compare with any integration page already there. Write a new page covering installation, the flow file, project and flow settings, recordings, reports and dry runs, and link out to the lighthouse-soft-navigation docs for step details. Done when the page is reachable from the docs navigation and each listed section is present.

Written by the indexing model from the issue text.

Description

Add an Integrations page that shows how to measure soft navigations in user flows with @push-based/lighthouse-soft-navigation: installation, the flow file, project and flow settings, recordings, reports and dry runs. The details of soft navigation steps stay in the lighthouse-soft-navigation docs, which the page links to.

Dominant language
HTML
Stars
131
Forks
7
Avg merge
7h 58m
Merged PRs (30d)
42

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from push-based/user-flow

All issues in push-based/user-flow

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.