Skip to content

Docs: Add telemetry page - #10059

Merged
JonnyBurger merged 1 commit into
mainfrom
codex/add-telemetry-docs
Aug 2, 2026
Merged

Docs: Add telemetry page#10059
JonnyBurger merged 1 commit into
mainfrom
codex/add-telemetry-docs

Conversation

@JonnyBurger

@JonnyBurger JonnyBurger commented Aug 2, 2026

Copy link
Copy Markdown
Member

Summary

  • add a Telemetry page to the License, Pricing and Compliance documentation
  • link the page from the sidebar and license overview
  • add a permanent /telemetry redirect

Testing

  • bun run build
  • bun run stylecheck

Preview

@vercel

vercel Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated (UTC)
bugs Ready Ready Preview Aug 2, 2026 9:26am
remotion Ready Ready Preview Aug 2, 2026 9:26am

Request Review

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ Minor suggestions on prose — nothing blocking.

Reviewed changes

  • New telemetry docs page: Adds /docs/license/telemetry explaining telemetry collection, sent information, license key setup, and usage tracking.
  • Sidebar, TOC, and redirect wiring: Registers the page in the License sidebar section, the license overview TOC component, the articles registry, and the /telemetry permanent redirect in Vercel config.

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow run | Using DeepSeek Pro (free via Pullfrog for OSS) (Claude Opus not used — the program covers this model; add its provider key to run your pick) | 𝕏

## APIs which send telemetry

Server-side rendering APIs do only send telemetry when the `licenseKey` option is set.
Client-side rendering APIs do always have telemetry.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider rephrasing: "Client-side rendering APIs always send telemetry." The current "do always have" construction is awkward.


## APIs which send telemetry

Server-side rendering APIs do only send telemetry when the `licenseKey` option is set.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider rephrasing: "Server-side rendering APIs only send telemetry when the licenseKey option is set." The current "do only send" construction is awkward.


## Tracking usage

After you set up the license key, you can now track your usage on the same Usage tab.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"the same Usage tab" reads as if the Usage tab was introduced earlier in the page, but it hasn't been. Consider either introducing the tab first ("go to the Usage tab") or dropping "same" ("track your usage in the Usage tab").

@JonnyBurger
JonnyBurger merged commit 603cc5c into main Aug 2, 2026
21 checks passed
@JonnyBurger
JonnyBurger deleted the codex/add-telemetry-docs branch August 2, 2026 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant