Repository navigation
Rewrite docs around setup and investigation tasks - #18
Open
Luke Shiels (skve) wants to merge 3 commits into
Open
Luke Shiels (skve) wants to merge 3 commits into
Luke Shiels (skve) wants to merge 3 commits into
Conversation
|
This branch has not been deployed
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.
The docs repeated setup across pages, left credential and framework setup steps incomplete, and described investigations without showing how to check an explanation. This rewrite gives readers a path from installing the SDK to verifying capture and investigating a checkout failure.
Validation: formatter, lint, TypeScript, Mintlify validation, anchor/redirect link checks, and git diff checks pass. Next.js and TanStack Start snippets typecheck in temporary app scaffolds. The source-map publisher passes local checks for UTF-8 chunking, hashes/debug IDs, repeat runs, upload failures, and empty builds, plus an actual-SDK test with mocked HTTP responses. The local preview serves the downloadable script byte-for-byte. No live telemetry was sent and no application code changed.
Outstanding visual work: replace the narrow Inbox/session crops and add an investigation screenshot, then review the updated pages in the browser. Browser spot-check on October 7 covered Introduction, Quickstart, Inbox, Investigations, and Session replay in the local preview. The Inbox image still shows only two rows, the replay image shows only the event list, and the investigation walkthrough has no screenshot. The earlier revision's framing, Compliance link, and API navigation were checked in light and dark mode. Final visual review remains pending after the screenshot updates. The repository also requires one approving review before merge.