Skip to content
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

Merged
merged 7 commits into from
Sep 14, 2024
Merged

Improved documentation #853

merged 7 commits into from
Sep 14, 2024

Conversation

DebajitKumarPhukan
Copy link
Contributor

  1. Updated version to latest available.
  2. Added a quickstart maven example section.

Copy link
Contributor

@kwwall kwwall left a 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.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@kwwall
Copy link
Contributor

kwwall commented Sep 14, 2024

@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.

Copy link
Contributor Author

@DebajitKumarPhukan DebajitKumarPhukan left a 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.

@DebajitKumarPhukan
Copy link
Contributor Author

@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".

Copy link
Contributor

@kwwall kwwall left a 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.

@kwwall
Copy link
Contributor

kwwall commented Sep 14, 2024

Since this is only documentation changes, I am going to merge PR this without the approval of @xeno6696 or @jeremiahjstacey.

@kwwall kwwall merged commit 57c12af into ESAPI:develop Sep 14, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants