Address the deficit of documentation
Open
- Dominant language
- Scala
- Stars
- 81
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Description
The documentation is sparse right now despite the fact that we can already do the things promised. We should lay out some simple instructions to deploy and use the code
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by surveying the repository’s existing documentation and the entry points for deploying and using the code. Document the currently supported deployment and usage workflow in simple instructions, and verify that the instructions match the behavior available in the project.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala, spark
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100