jakartaee / jakartaee/jsonb-api
Users Guide is outdated
Open
- Dominant language
- Java
- Stars
- 95
- Forks
- 41
- Avg merge
- 1d 6h
- Merged PRs (30d)
- 35
Description
The [Users Guide](https://github.com/eclipse-ee4j/jsonb-api/blob/master/docs/src/docs/user-guide.adoc) still refers to Json Binding 1.0.1. It would be nice if it could be updated to reflect current best practices and help new users better understand how to use the API. Thanks!
Contributor guide
Research direction
Start with docs/src/docs/user-guide.adoc and review its references to Json Binding 1.0.1 against the current API and best practices. Update the guide so it accurately explains current usage and is more helpful to new users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100