Skip to content

Docs cleanup: fix Client constructor examples and document new SDK features #27

Description

@jpetey75

Tracking issue for a docs pass (to be bundled with the upcoming bulk docs update). Kept separate from the feature PRs to keep those small.

Bugs to fix

  • docs/SDK_GUIDE.md uses the wrong Client(...) signature. Lines 10 and ~383 show Client(base_url=..., token=...), but the real constructor is Client(instance_url=..., access_token=..., project_uuid=...) (the README is correct). Copy-pasting the guide snippet currently fails.

Features to document (landing via open/merged PRs)

Nice-to-have

  • Align the SDK_GUIDE.md Quick Start with the README (same constructor, same auth guidance).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions