clockworklabs / clockworklabs/SpacetimeDB
Docs - quickstarts: make this a "tutorial;" replace with a shorter "quickstart"
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
Applies to all of the modules//quickstart.md and the sdks//quickstart.md .
Architect and write once for one language, then port to all other languages. Ensure that modules and clients are compatible cross-language.
Either use the spacetime init default module for this quickstart, or replace that default module with the one used by this quickstart.
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 by reviewing modules//quickstart.md and sdks//quickstart.md, then compare the spacetime init default module with the module used by the quickstart. Choose one language as the reference and trace how its quickstart should be ported to the other languages. Done means the quickstarts use a shorter, consistent flow and the modules and clients remain cross-language compatible.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100