Skip to content

Docs consistency sweep: SDK version floors, dup block, badges #906

@zeevdr

Description

@zeevdr

Description

Cross-repo README inconsistencies, one of which is a correctness bug: the SDKs state different minimum server versions, so at least one set of users is told the wrong floor. This sweep also covers a duplicated requirements block and inconsistent status badges. Edits land in decree-python and decree-typescript; tracked here in the hub repo.

Acceptance criteria

  • Server-version floor (correctness). decree-python/README.md:110 says the server is "v0.3.0+"; decree-typescript/README.md:124 says "v0.8.0 – v0.x". These can't both be the real minimum. Determine the actual supported floor per SDK (the TS SDK generates SUPPORTED_SERVER_VERSION and has compat.ts — use that as source of truth) and correct both READMEs to match reality.
  • TS duplicate requirements. decree-typescript/README.md states the Node 22+ requirement twice (:16-18 and :121-124); collapse to one.
  • Status badge alignment. decree/README.md uses repostatus "active" while the SDK / UI / demos READMEs use "WIP"; pick a consistent signal per maturity, or document why they differ.

References

  • decree-python/README.md:110; decree-typescript/README.md:124, :16-18, :121-124
  • Status badges: decree/README.md:13 vs decree-python/README.md:8, decree-typescript/README.md:8, decree-ui/README.md:5, demos/README.md:4
  • Touches: decree-python, decree-typescript (plus badge tweaks across all repos)

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentationpriority: P0Blocks alpha or releasepython-sdkPython SDK (opendecree)size: SQuick win — a few hours or lesstypescript-sdkTypeScript SDK (@opendecree/sdk)

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions