Documentation
- Dominant language
- TypeScript
- Stars
- 191
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Add documentation to repo.
- [ ] API documentation
- [ ] Design documentation - at a high level, what is statecraft, what problems is it aiming to solve
- [ ] Differences with other systems:
- Kafka
- SQL
- Datomic
- Message queue
- [ ] Demos & examples, with documentation each time
- [ ] Roadmap
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the checklist in issue #7 and survey the repository to determine where documentation currently lives. Define the high-level explanation of Statecraft, API documentation, comparisons with Kafka, SQL, Datomic, and message queues, demos with examples, and a roadmap. Done means each requested section is documented and the examples have accompanying explanations.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100