Skip to content

[Docs] Publish ROADMAP.md and an API stability / deprecation policy toward 1.0 #145

@dgenio

Description

@dgenio

Summary

Add a public ROADMAP.md that organizes open issues into themes and milestones on the path to 1.0, plus an explicit API stability and deprecation policy: what is stable today, what may change before 1.0, and how breaking changes are communicated.

Why this matters

The project ships fast (ten minor releases, one already-handled breaking rename) and has a rich issue backlog — but an evaluator can't currently tell where it's going or how risky it is to depend on. A roadmap converts the backlog into a story ("audit durability → protocol coverage → hardening → 1.0"), and a written stability contract is precisely what turns "interesting Alpha" into "we can build on this". The 0.10.0 import rename was handled well; codifying that practice multiplies its trust value.

Proposed scope

Implementation notes

  • Keep it one page; a roadmap nobody maintains is worse than none — add a "last reviewed" date and a note that issues are the source of truth.
  • 1.0 criteria should be concrete and checkable (e.g., stability policy enforced for N releases, hardening roadmap items from security: production-hardening roadmap + ship the first piece (token signing/encryption, pluggable secrets/auth) #103 shipped, weaver-spec conformance suite running in CI rather than the current placeholder).
  • The deprecation policy should reference the existing practice from the 0.10.0 rename (parallel naming window, CHANGELOG breaking entry) as the template.

Acceptance criteria

  • ROADMAP.md published with themed, issue-linked direction and a last-reviewed date.
  • Stability/deprecation policy defines the public API surface and breaking-change mechanics.
  • 1.0 criteria stated concretely.
  • Milestones created and populated; README/CONTRIBUTING link the roadmap.

Out of scope

References


Priority: P1 · Effort: S · Impact: High

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions