Skip to content

Split SDK Documentation by Language for Independent Releases #3617

@flopez7

Description

@flopez7

Description
Currently, whenever we release the SDK, both the TypeScript and Python versions need to be published together, even if only one has changed, because their documentation is tied in a single structure. This creates unnecessary work and artificial version bumps. For example, a Python-only fix requires a dummy TS release just to refresh shared docs.

We need to split the documentation per language so each SDK can release independently. The main blocker is backfilling old versions, as it would require recreating the historical docs structure manually

Motivation

  • Reduce artificial version bumps and dual publishes.
  • Simplify documentation updates and release workflows.
  • Improve clarity by maintaining isolated changelogs per language.

Implementation details

  1. Freeze all SDK versions ≤4.x as legacy, placing them under a single archived documentation section.
  2. Start fresh from v5 onward with separated docs spaces:
    • TS SDK → dedicated docs section and navigation
    • Python SDK → dedicated docs section and navigation
  3. Each SDK will follow its own release cadence and doc updates.
  4. Ensure CI/CD pipelines and auto‑publishing workflows support this decoupled structure.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions