docs: document known rough edges (#609)

Start keeping a log of rough edges we've discovered post v1.0.0, so that
they're discoverable (along with their workarounds), and so that we can
fix them in v2.
This commit is contained in:
Robert Findley 2025-10-29 10:57:45 -04:00 • committed by GitHub
commit 32d84d8421
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

12
docs/rough_edges.md Normal file
View file

@ -0,0 +1,12 @@
<!-- Autogenerated by weave; DO NOT EDIT -->
# Rough edges: API decisions to reconsider for v2
This file collects a list of API oversights or rough edges that we've uncovered
post v1.0.0, along with their current workarounds. These issues can't be
addressed without breaking backward compatibility, but we'll revisit them for
v2.
- `EventStore.Open` is unnecessary. This was an artifact of an earlier version
of the SDK where event persistence and delivery were combined.
**Workaround**: `Open` may be implemented as a no-op.