-
Notifications
You must be signed in to change notification settings - Fork 93
Open
Description
Is your feature request related to a problem? Please describe.
The base/account-sdk README focuses primarily on usage examples and API surface, but it does not clearly communicate lifecycle, support expectations, or intended usage boundaries (e.g., experimental vs stable APIs).
Describe the solution you'd like
- Add a dedicated section to the README (e.g. “Project Status” or “Stability & Support”).
- Clearly document:
- current maturity level (stable, evolving, experimental)
- expectations around breaking changes and versioning
- intended usage (production-ready vs early adoption)
- Optionally reference related resources such as release notes or changelog.
Acceptance Criteria
- README includes a clear and concise section describing project status and expectations.
- Developers can easily assess whether the SDK fits their production needs.
- No changes are made to SDK behavior or public APIs.
- Documentation remains easy to maintain and update over time.
Additional context
No response
Metadata
Metadata
Assignees
Labels
No labels