Skip to content

docs: weekly drift audit (2026-06-22)#210

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/audit-2026-06-22
Open

docs: weekly drift audit (2026-06-22)#210
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/audit-2026-06-22

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Automated weekly docs audit. See workflow: `.github/workflows/docs-audit.yml`.

Fixes committed in this PR

marketing/src/app/docs/web-sdk/page.tsx — three edits

  • Rift.click() API description changed from "record a click event … fire-and-forget via sendBeacon" to "stamp the clipboard URL for deferred attribution … makes no HTTP call". Source: sdk/web/src/index.ts:86-88click() calls only copyLinkToClipboard().
  • linkId param description changed from "The link ID to record a click for" to "The link ID to stamp onto the clipboard for deferred attribution". Same source.
  • "How it works" step 2 removed the false sendBeacon → POST /v1/lifecycle/click claim; replaced with accurate clipboard-stamp description. Source: sdk/web/src/index.ts:50-54.

marketing/src/app/docs/lifecycle/page.tsx — four edits

  • Web SDK click-reporting tab: removed "the SDK fires a sendBeacon request to POST /v1/lifecycle/click"; replaced with accurate description. Source: sdk/web/src/index.ts:86-88.
  • iOS "Bind the user" snippet: try? await rift.setUserId("usr_abc123")try? await rift.setUserId(userId: "usr_abc123"). Swift requires the argument label; omitting it is a compile error. Source: client/mobile/dist/ios/Sources/RiftSDK/rift_ffi.swift:541.
  • Direct redirect mode table: expanded the single "Desktop → Web URL" row into macOS (Mac App Store URL or web), Windows (Microsoft Store URL with ?cid or web), and Other (web URL), matching the explicit_redirect_target function added in PR feat(links): platform-aware auto-redirect (macOS/Windows) + redirect_mode #196. Source: server/src/api/links/routes.rs:919-928.
  • Identify webhook example: added missing last_touch_link_metadata field alongside last_touch_link_id. Source: server/src/core/models.rs:131-134.

marketing/src/app/docs/links/page.tsx — one edit

marketing/src/app/docs/webhooks/page.tsx — four edits

  • Create response id field: "6650a1b2c3d4e5f6a7b8c9d0""wh_6650a1b2c3d4e5f6a7b8c9d0". Source: server/src/core/public_id/mod.rs:392 (WebhookId prefix = "wh").
  • Identify event payload: added missing last_touch_link_id and last_touch_link_metadata fields. Prose said "carries first-touch and last-touch link credit" but the JSON example only showed first-touch. Source: server/src/core/models.rs:131-134.
  • Conversion event payload event_id: "66a1b2c3d4e5f6a7b8c9d0e1""cev_66a1b2c3d4e5f6a7b8c9d0e1". Source: server/src/core/public_id/mod.rs:302 (ConversionEventId prefix = "cev").
  • Conversion event payload source_id: "66a1b2c3d4e5f6a7b8c9d0e2""src_66a1b2c3d4e5f6a7b8c9d0e2". Source: server/src/core/public_id/mod.rs:371 (SourceId prefix = "src").

marketing/src/app/docs/conversions/page.tsx — two edits

  • iOS setUserId snippet (Option B, Step 2): try? await rift.setUserId("usr_abc123")try? await rift.setUserId(userId: "usr_abc123"). Same compile-error issue as lifecycle page. Source: client/mobile/dist/ios/Sources/RiftSDK/rift_ffi.swift:541.
  • Source list response id field: "66a1b2c3d4e5f6a7b8c9d0e1""src_66a1b2c3d4e5f6a7b8c9d0e1". Source: server/src/core/public_id/mod.rs:371.

Judgment calls for human review (NOT committed)

PATCH /v1/webhooks/{id} not documentedmarketing/src/app/docs/webhooks/page.tsx only documents Create, List, and Delete. The update endpoint added in PRs #126 and #127 (PATCH /v1/webhooks/{webhook_id} accepting { active, events, url }) is not mentioned. Source: server/src/api/webhooks/routes.rs:184-281. This is an omission, not a factual error in what is documented.

marketing/src/lib/agent-docs.ts:114 — The llms.txt content links to ${siteUrl}/docs/attribution which 404s (no such page exists). The correct path is /docs/lifecycle (renamed in PR #130). This file is outside the literal edit scope (marketing/src/lib/ vs marketing/src/app/). The one-character fix: change docs/attribution to docs/lifecycle in buildLlmsText(). Source: confirmed — marketing/src/app/docs/ has no attribution/ directory.

Out of scope (flagged, not fixed)

marketing/src/app/api-reference/ is auto-rendered from the OpenAPI spec. No issues found that require utoipa annotation changes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
rift Ready Ready Preview, Comment Jun 22, 2026 3:57pm

Request Review

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.

0 participants