clockworklabs / clockworklabs/SpacetimeDB
Docs - sdks/index.md: Add more detail about how subscriptions work
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
After implementing the new subscription API. Give people a good mental model of adding/removing queries to/from their subscribed set, what it means to query the client cache, what happens when a subscription ends, &c. Depending on how long this is, either add it do sdks/index.md, or give it its own file sdks/subscription.md.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the existing SDK documentation in sdks/index.md and review the new subscription API behavior. Document the mental model for adding and removing queries, querying the client cache, and ending a subscription, using sdks/index.md or a new sdks/subscription.md file as appropriate.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100