Repository navigation
docs(ui-capture): dashboard quickstart and walkthrough with screenshots - #988
Merged
Merged
Conversation
The UI Testing section gets its first two task pages and a landing that routes to them: - ui-capture/quickstart-dashboard: create an ingest key in UI Testing -> UI Flows, add it to the React sample shop, use the shop, watch the sessions arrive and read the flows; why visitors who send Do Not Track or Global Privacy Control never show up. - ui-capture/walkthrough-dashboard: five scripted visits along three paths, capture status, the flows and their names, one flow's steps and calls, the journeys and how Keploy selects the ones it tests, the same data over the Public API, and cleanup. - running-keploy/ui-capture becomes the section's overview for SDK 3.1.0: what works today (replay is beta and its runner is not in a release build), the REST and MCP setup, the SDK's options, privacy, limitations and troubleshooting. Every heading id it had is kept except #before-you-begin, which nothing links. The sidebar's UI Testing category links the overview and groups the pages into Quickstarts, Walkthroughs and Reference. The errors page links the quickstart's key step, and says that the keploy ui commands, the replay runner among them, are not in a release build yet. The docs home gets a UI Testing card, a UI capture quickstart tile and a capability chip, and llms.txt a UI Testing section. The screenshots were taken from Keploy's staging dashboard with the sample shop on SDK 3.1.0 and a throwaway app, with keys blanked and staging hosts shown as production's. Five images replace the old ones at the same paths, two of which the SDK's npm README embeds. Signed-off-by: slayerjain <shubhamkjain@outlook.com>
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.
What this does
The UI Testing section gets its first two task pages, and its old single guide becomes an overview that routes readers to them. Written for
@keploy/capture-sdk3.1.0, now on npmlatest.New:
/docs/ui-capture/quickstart-dashboard/(Dashboard quickstart). In about 10 minutes: open UI Testing → UI Flows, create an ingest key, put it in the React sample shop, use the shop, watch the sessions arrive, end a visit with/complete, and read the flows and one flow's steps and calls. It closes with why visitors who send Do Not Track or Global Privacy Control never show up.New:
/docs/ui-capture/walkthrough-dashboard/(From first visit to journeys). Five scripted visits (npm run demo:visits) along three paths; capture status and every state's line on the card; the 15 flows and how a flow is named; one flow's steps (typed text masked) and calls; the Journeys tab, and how Keploy selects the journeys it tests, worked through on these five sessions; the same data over the Public API; revoking the key and deleting the app.Rewritten:
/docs/running-keploy/ui-capture/(Overview; the URL the SDK's npm README links three times and the navbar's UI Testing item opens). How capture works, with the same two screenshots the npm README shows; what works today (replaying journeys as Playwright tests is beta and its runner is not in a release build yet; what the flow page's Generate Test does today, in the dashboard's own words); setup in the dashboard (links to the new pages), with the REST API and from an AI agent over MCP; installing the SDK; all 3.1.0 options; privacy at a glance; limitations; troubleshooting. Changes for 3.1.0: SPA route changes are recorded now (the old "not yet recorded" limitation is gone), no-bundler pages work with an import map, the MCP tool list covers journeys and runs, and the SDK options table lists all 15 options.Every heading id the old page had is kept as a real heading, so existing links and the SDK's README still land on a section:
#how-ui-capture-works,#set-up-ui-capture-in-the-dashboard,#set-up-ui-capture-with-the-rest-api,#create-an-ingest-key,#check-that-capture-is-working,#read-the-flows,#manage-ingest-keys,#set-up-ui-capture-from-an-ai-agent-mcp,#what-an-agent-sees,#install-the-sdk(the 3.0.1 README's/ui-capture/install-sdk/redirect target),#sdk-options,#what-the-sdk-records-and-what-it-masks(now "Privacy at a glance"),#limitations,#troubleshooting. Only#before-you-beginis gone; nothing links it.Also:
ui-capture/errors.md: the "mint a key in the dashboard" link points at the quickstart's step, and "Handle errors from the Keploy UI tools" says that thekeploy uicommands, the replay runner among them, are not in a release build yet, as the other pages do.ItemList), a UI capture tile under Quick Starts, and a "UI journey capture" chip with a Beta badge under Testing Flexibility.llms.txt: a UI Testing section.ProductTieron all three pages: all plans, self-hosted and dedicated.Screenshots
Eleven, all WebP under 180 KB. Five replace the old ones at the same paths, including the two the npm README embeds (
ui-capture-flows.webp,ui-capture-flow-detail.webp); six are new.They were taken by a Playwright script on a build box against Keploy's staging dashboard and API, with the React sample shop on SDK 3.1.0 running on
localhost:4173as a reader runs it, in a throwaway app created for the run and deleted after it (its key revoked, the app gone:GETanswered 404). Only element shots: no header, app picker or account menu. Keys are blanked tokep_and dots, and the staging host is written asapi.keploy.io. The card's Create ingest key request was answered with a key minted for the same app through the Public API in the same second, because a script cannot pass the dashboard's recent sign-in check. The flow page shot is the steps and calls cards only, without the header row that holds Generate Test.Sources checked
Every sentence was checked against:
packages/sdk/README.md(install :55-163,initand options :165-218, first requests :420-427, privacy modes :465-520, privacy signals :605-614 and :203, network :616-891,onErrorexample with Brave and DuckDuckGo :2025-2033, sampling :2078-2080).constants/navItems.ts:160-171;app/ui-testing/page.tsx(onboarding :256-351, flows tab and per-route note :463-626, page title and tabs :1158-1196);app/ui-testing/[flowId]/page.tsx(step labels :112-131, Step Timeline and Network Calls :160-279, pending-run box :552-567, Generate Test :606-622);components/ui-testing/CaptureSetupCard.tsx(snippet :58-66, state lines :115-138, key name default :231, card :289-488);components/ui-testing/JourneysTab.tsx;components/ui-testing/ShareFigure.tsx:63-72;components/auth/ReauthenticationDialog.tsx:213, 260;components/api-keys/ApiKeysTable.tsx,CreateTokenDialog.tsx.pkg/service/uicapture/session_sweep.go:33-52;pkg/http/apiv1/uiingest.go:152-153, 330-361;pkg/http/apiv1/uiingest_auth.go:36-46, 139;pkg/service/uicapture/capture_status.go:97-147;pkg/http/apiv1/uicapture_agent.go(setup andnext:181-308, agent view :637-990);pkg/service/uicapture/journeys/plan.go(move weights :458-460, selection :575-633);pkg/models/uicapture_journey_plan.go:166-167;pkg/service/uicapture/flowengine/dedup.go:380-409(flow names);pkg/mcp/meta_tools.go:72-97;pkg/models/step_up.go:71;pkg/http/apiv1/openapi.yaml(apps :42-108,uiJourneys:2617-2644,CreateAppRequest:3522-3535).ui-capture-react-shop: the quoted.envandsrc/keploy.tslines are the sample's own, and the visits table followsscripts/visits.mjs.The JSON on the walkthrough is from the same staging run as the screenshots, with ids replaced.
Checks
On a build box, with CI's commands (node 22, yarn 1.22):
prettier@2.8.8 --checkon the changed.jsand.mdfiles (TestingCapabilities.jsis now in prettier's format: that file's diff is formatting only, plus one item)src="/docs/…"resolves understatic/yarn install --frozen-lockfileand the yarn.lock checkyarn buildonmainand on this branch: neither prints a warning or error line, so the branch adds none (onBrokenLinks: throw)verify-linkedin-tag,verify-schema,verify-lastmod,verify-moved-urlsandverify-ui-capture-sdk-links(49 error sections, 5 refused verbs, 4 README links)In the built site: the overview's 15 heading ids (those listed above and
#what-works-today) and the 16 step anchors of the two new pages exist; every image on the three pages is in the build; a rendered-text comparison of each page's source with its HTML differs only at the JSX components (HowTo,ProductTier, the images) and code-block titles, and the errors page differs nowhere; the home page carries the UI Testing card, itsItemListentry and the capability chip;llms.txtand the sitemap list both new pages.Merge
After keploy/samples-typescript#116 merges: both new pages clone and link its
ui-capture-react-shopfolder.