clockworklabs / clockworklabs/SpacetimeDB
Docs - Rust client quickstart text is out of date; references function that doesn't exist
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
The Rust client quickstart references e.g. print_messages_in_order, a function that doesn't exist. Update the text to not refer to it, and also, read through the entire quickstart carefully and ensure that the text and code are correct and consistent.
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
Start with the Rust client quickstart referenced in the issue and read the full page, checking each example against the current Rust client API. Remove the reference to print_messages_in_order, correct any other inconsistencies you find, and confirm that the documented text and code agree throughout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100