Skip to content

Clarify PostHog key safety - #6918

Merged
ethanpalm merged 2 commits into
mainfrom
ethan/doc-415-posthog-key-safety
Aug 8, 2026
Merged

Clarify PostHog key safety#6918
ethanpalm merged 2 commits into
mainfrom
ethan/doc-415-posthog-key-safety

Conversation

@ethanpalm

@ethanpalm ethanpalm commented Aug 8, 2026

Copy link
Copy Markdown
Collaborator

Documentation changes

Closes https://linear.app/mintlify/issue/DOC-415/clarify-posthog-integration-api-key-exposure-and-env-var-handling


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Low Risk
Documentation-only wording change with no runtime, security, or data-handling code impact.

Overview
Adds guidance under the apiKey configuration option explaining that PostHog project keys starting with phc_ are client-side, public tokens (the same value sent from the browser with events) and that committing them in a docs repo is acceptable.

This is documentation-only and addresses confusion about treating the key like a secret or relying on env vars for docs configuration.

Reviewed by Cursor Bugbot for commit bcdbaa6. Bugbot is set up for automated code reviews on this repo. Configure here.

Users were avoiding committing the apiKey out of caution, unaware
it's a client-side token already exposed in every browser request.

Fixes DOC-415 / #609
@mintlify

mintlify Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 8, 2026, 12:37 AM

@mintlify

mintlify Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Aug 8, 2026, 12:37 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@ethanpalm
ethanpalm merged commit 2e99d5e into main Aug 8, 2026
6 checks passed
@ethanpalm
ethanpalm deleted the ethan/doc-415-posthog-key-safety branch August 8, 2026 00:37
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.

2 participants