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

View file

@ -38,3 +38,9 @@ protocol.
# TroubleShooting
See [troubleshooting.md](troubleshooting.md) for a troubleshooting guide.
# Rough edges
See [rough_edges.md](rough_edges.md) for a list of rough edges or API
oversights that can't be addressed due to our compatibility promise. We'll
revisit these if/when we move to a v2 of the SDK.