-
Notifications
You must be signed in to change notification settings - Fork 524
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
docs: fixes and updates for README.md #831
Conversation
Signed-off-by: Ben Cressey <bcressey@amazon.com>
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.
Modulo the ordering nit. Thanks!
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.
nit: I think it reads better with the description of each doc directly after the link, rather than in a new paragraph, so they're not disjoint.
Signed-off-by: Ben Cressey <bcressey@amazon.com>
Issue number:
N/A
Description of changes:
Fixes a couple typos and broken links in README.md. Updates the security section to refer to the new docs.
Testing done:
Rendered via GitHub API.
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.