Make a static site for this project
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 37
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
If you like I can have @hrshdhgd do this using either sphinx or mkdocs (I would do mkdocs with a material theme)
However, there may be a preferred way of making docs for scala projects that exposes the scala API
The first pass would be just to break the README into a couple of pages:
- about.md
- install.md
- running.md
then we can add more docs for different workflows etc
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 README and assess whether Sphinx, MkDocs, or a Scala-oriented documentation approach best exposes the API. Organize the first pass into about.md, install.md, and running.md, with the README content distributed across those pages; completion means those initial pages exist and support later workflow documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scala
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100