From 45d9602242d74e8a0ce2f28709f32c98e7c713c2 Mon Sep 17 00:00:00 2001 From: Pavan Kumar <66913595+ascender1729@users.noreply.github.com> Date: Mon, 9 Jun 2025 19:22:02 +0000 Subject: [PATCH] docs: document telemetry configuration and update mkdocs config --- docs/mkdocs.yml | 1 + docs/swarms/telemetry.md | 2 ++ 2 files changed, 3 insertions(+) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index d4e9725c..1f4f97f0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -178,6 +178,7 @@ nav: - Installation: "swarms/install/install.md" - Environment Configuration: "swarms/install/env.md" - Quickstart: "swarms/install/quickstart.md" + - Telemetry Setup: "swarms/telemetry.md" # - Swarms CLI: "swarms/cli/main.md" # - Swarms Framework Architecture: "swarms/concept/framework_architecture.md" # - Swarm Ecosystem: "swarms/concept/swarm_ecosystem.md" diff --git a/docs/swarms/telemetry.md b/docs/swarms/telemetry.md index bac54b7b..cd0cb3b7 100644 --- a/docs/swarms/telemetry.md +++ b/docs/swarms/telemetry.md @@ -15,6 +15,8 @@ This initialization ensures minimal console output while still capturing importa ## Enabling or Disabling Telemetry Telemetry collection is controlled with the environment variable `USE_TELEMETRY`. +By default, telemetry is disabled, so no data is sent unless you explicitly set +`USE_TELEMETRY=true`. ```bash # Enable telemetry