Skip to content

Stability Rubric: Endpoint-Level Stability Indicators #13

@johnx25bd

Description

@johnx25bd

Priority: Critical

Description

"Research Preview" and "code snippets need testing" warnings repeat frequently throughout the documentation, but this doesn't triage risk effectively. Readers cannot tell what is safe to build on today.

Fix Direction

  • Introduce a simple stability rubric applied consistently:

    • Stable - API + behavior committed
    • Beta - minor breaking changes possible
    • Research - expect breakage
  • Apply the rubric at the endpoint/method level, not just as a banner

  • If keeping "code snippets need testing," add a link to:

    • A tested example repo, OR
    • An integration test suite status page

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Medium prioritydocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions