We should document that the Rust crate version on crates.io is currently synced to the npm release version, and does not represent an independent semantic-versioning contract for the Rust API.
Suggested scope:
- Add a short note in an obvious public place (for example docs/release docs/README/crates section)
- Explain that the crates.io version is aligned with npm releases
- Set expectations that Rust releases are not following semver independently
Context:
- We released 1.0, which may make people assume semver guarantees for the Rust crate
- This has already caused confusion internally in Discord
We should document that the Rust crate version on crates.io is currently synced to the npm release version, and does not represent an independent semantic-versioning contract for the Rust API.
Suggested scope:
Context: