Skip to content

Docs Request: Document analytics, telemetry, and tracking usage across the Base website #2863

@surreal-look0e

Description

@surreal-look0e

What is the issue you are encountering with the docs?

The base/web repository does not clearly document how analytics, telemetry, or tracking are implemented across the site. Contributors and reviewers may find it difficult to understand what data is collected, where it is configured, and how changes should be made responsibly.

Problem Description

Without explicit documentation, developers may be unsure about:

  • which analytics or tracking tools are in use
  • where tracking events are defined or triggered
  • how to add, modify, or disable analytics safely
  • how analytics differ between environments (local, staging, production)

Links to Impacted Docs

No response

Describe the solution you'd like to see.

Add a documentation section (or doc file) describing:

  • which analytics or telemetry tools are used
  • where tracking is initialized and configured
  • general guidelines for adding or modifying events
  • environment-specific considerations (local vs production)
  • Keep documentation descriptive and non-invasive.

Acceptance Criteria

  • Documentation clearly explains analytics and tracking at a high level.
  • Contributors can locate and understand tracking-related code more easily.
  • No changes are made to runtime behavior or data collection.
  • Documentation is concise and easy to maintain.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions