Add doc page or blog post on Java usage
Nobody has claimed this yet.
- Dominant language
- Clojure
- Stars
- 644
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
From #269:
Yes, 0.2.23 worked for me, although I am missing any docs on how to make the library work for me. I guessed around a bit, and got a sample file from the YAMLStar repository and some clues. It really begs for a more Java oriented wrapper around it all, as casting is kinda not idiomatic Java. I've included the code that eventually worked, should it be helpful for anyone else who should also be new to this and need some direction.
Contributor guide
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
Review issue #269 and the working Java example referenced in this issue first. Add a documentation page or blog post explaining how to use the library from Java, including the direction new users need; done means newcomers can follow the documented Java usage without guessing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100