SpacetimeDB icon indicating copy to clipboard operation
SpacetimeDB copied to clipboard

Add readmes to all implementation crates specifying that they do no offer stable interfaces

Open mamcx opened this issue 10 months ago • 0 comments

Description of Changes

Closes private #1156.

Notes to reviewer:

  • Binaries are not documented, so I don't put the readme there

  • It could be desirable to use doc = false, but it need judgments here, like it could be nice to see what sats are or see at the internal documentation of the core.

  • I not decided if should add the same note to the lib.rs so is visible in docs.rs. Should I?

  • Readme's with **Internal Crate** are distinct from **Unstable Crate** for what I think the later is useful for the public to see and know, but is still in flux.

API and ABI breaking changes

It could change what is seen in crates.rs/docs/rs, that is intentional.

Expected complexity level and risk

1

Testing

  • [x] Attempt to run cargo +nightly publish -Z package-workspace --allow-dirty --dry-run --workspace --exclude ..., but it failed in weird ways, so this depends on manual inspection.

mamcx avatar Feb 27 '25 18:02 mamcx