Skip to content

Rewrite docs around setup and investigation tasks - #18

Open
Luke Shiels (skve) wants to merge 3 commits into
mainfrom
docs/editorial-rewrite
Open

Luke Shiels (skve) wants to merge 3 commits into
mainfrom
docs/editorial-rewrite

Conversation

@skve

@skve Luke Shiels (skve) commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

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.

  • Move SDK installation below Quickstart, separate feature configuration, and fold Activity into Inbox with a redirect.
  • Complete Next.js, Vite, and TanStack Start setup examples, including mounted test buttons, Start request middleware, and browser/server verification. Make shared browser guides explicit about framework support and clear identity on sign-out.
  • Replace the workspace-key guide's unexplained access-token prerequisite with CLI browser sign-in, scoped key creation, and revocation. Link Terraform setup to that flow.
  • Add a downloadable Node.js/NestJS source-map publisher covering debug IDs, hashing, chunked uploads, and finalization. Document the build/deploy order and keep package-manager tabs on install commands.
  • Walk through a store-pickup checkout failure using Timeline, Findings, Sessions, assignment, and recovery. Remove internal tracing mechanics and filler.
  • Add session replay, members and roles, notifications, and API authentication guides. Correct role permissions, company associations, and Terraform coverage against product source.
  • Keep Compliance as an external link to https://interfere.com/security in a new tab, with a redirect from the old article.

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.

@changeset-bot

changeset-bot Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2a19402

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant