Skip to content

Clarify required configuration and authentication setup for CDP SDK #521

@feeder-irate

Description

@feeder-irate

Expected behavior:

  • Documentation clearly lists all required configuration and authentication fields.
  • A minimal, copy-paste-ready setup example is provided.
  • Errors caused by missing configuration are easy to understand and fix.
    Proposed solution:
  • Add a dedicated “Getting Started” or “Authentication Setup” section to the README.
  • Explicitly mark required vs optional configuration fields.
  • Include a minimal working example demonstrating successful SDK initialization.
    Acceptance criteria:
  • New users can successfully authenticate on first attempt.
  • Setup-related errors are reduced during onboarding.
  • Documentation provides clear guidance for correct SDK configuration.

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