Skip to content

docs(authentication): add an FAQ entry on usage metrics - #106

Draft
djsauble wants to merge 1 commit into
mainfrom
later-triage/auth-faq-usage-metrics
Draft

djsauble wants to merge 1 commit into
mainfrom
later-triage/auth-faq-usage-metrics

Conversation

@djsauble

@djsauble djsauble commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Draft. Adds an FAQ entry on usage metrics to the authentication page.

14 lines, one new <Accordion> in the existing FAQ group.

What it claims, and where each claim comes from

  • The metrics payload — "a unique token and the subcommand issued" — is the wording already in man/flox-config.mdx and man/flox.mdx under ENVIRONMENT VARIABLES.
  • flox config --set disable_metrics true and FLOX_DISABLE_METRICS=true are both documented in man/flox-config.mdx. Verified against flox 1.17.0: --set takes the string and flox config -l reads back disable_metrics = true; --delete=disable_metrics restores false.
  • Privacy policy URL from src/pages/privacy-policy.tsx in floxwebsite.

Two things to decide before this ships

  1. A reviewer asked for the entry to explain that Flox does not collect code. This draft does not say that. The privacy policy contains no mention of metrics, source code, intellectual property, telemetry, or usage data, so it does not currently back the assurance — and flox install does send package descriptors to the catalog to resolve them, so a blanket "we collect no code" would be wrong as written.
  2. Wording and FAQ placement — it currently sits between "What if I miss the deadline?" and "Do you have an option that isn't public FloxHub?".

@mintlify

mintlify Bot commented Oct 2, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
flox 🟢 Ready View Preview Oct 3, 2026, 2:44 AM

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

Add an FAQ entry on the authentication page covering what data
authenticated users send and how to send less.

Scoped to what the docs already assert: the metrics payload documented in
flox-config (a unique token and the subcommand issued), both documented
ways to switch it off, and a link to the privacy policy. Deliberately does
not claim we collect no code or IP -- that assurance is not in the privacy
policy today, and resolution does send package descriptors to the catalog,
so a blanket sentence would be wrong.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
staging — e1a98edc Deployed Oct 3, 2026 by mintlify[bot]
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