Skip to content

JOSE review – Documentation checklist #14

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

Open
corybrunson opened this issue Apr 8, 2023 · 1 comment
Open

JOSE review – Documentation checklist #14

corybrunson opened this issue Apr 8, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@corybrunson
Copy link

Hi @TrevorFrench and thanks for the thorough resource—i'm enjoying reading it.

Following discussion in the review thread, the repository—preferably the README—should include the following items from the Documentation checklist, most of which i think are adequately addressed; the exception is a statement of need. Would you be able to add some text (i think a sentence or two would do) to the opening paragraph that motivates this work amidst the other resources available to your target readership?

Part of this JOSE review.

@TrevorFrench TrevorFrench self-assigned this Apr 8, 2023
@TrevorFrench TrevorFrench added the documentation Improvements or additions to documentation label Apr 8, 2023
@TrevorFrench
Copy link
Owner

TrevorFrench commented Apr 8, 2023

Hey @corybrunson - thanks for agreeing to review!

I just updated the README in PR #20 to include the statement of need. Let me know if you think that's alright.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants