-
Notifications
You must be signed in to change notification settings - Fork 364
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improved documentation #853
Conversation
DebajitKumarPhukan
commented
Aug 31, 2024
- Updated version to latest available.
- Added a quickstart maven example section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See my other comments for the changes requested. IMO, our README is already too long.
@DebajitKumarPhukan - I'd like to do a release soon (no later than 9/22). Do you think you can make the requested changes by then? If not, these changes will have to wait until the end of November. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New updates as per suggestions.
@kwwall Thank you so much the gentle reminder. I got occupied (and lost a bit) in my day to day work. I have made the necessary changes as requested and also shared some reasons on "why". |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with the changes, as-is, although I likely will move some of this to our wiki page. These additions are easily going to push our README.md to 9 pages.
Since this is only documentation changes, I am going to merge PR this without the approval of @xeno6696 or @jeremiahjstacey. |