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

Small documentation updates #62

Merged
merged 3 commits into from
Feb 2, 2024
Merged

Small documentation updates #62

merged 3 commits into from
Feb 2, 2024

Conversation

cpu
Copy link
Member

@cpu cpu commented Feb 2, 2024

  • Remove some duplicated content from the top-level README
  • Update the webpki-roots rustdoc to recommend rustls-platform-verifier instead of rustls-native-certs
  • Port the recommendation/warning from rustdoc to the top-level README

@cpu cpu self-assigned this Feb 2, 2024
@cpu cpu marked this pull request as draft February 2, 2024 15:30
We already say that this crate is inspired by certifi.io and uses CCADB
data in the line immediately preceding the one deleted in this commit.
Now that the platform verifier is available, point to that crate instead
of the native certs crate. The platform verifier README already touches
on native certs (and why the platform verifier is a better choice).
We already had a version of this warning in the webpki-roots crate's
top-level rustdoc. This ports the warning to the top-level git README so
that it is visible to folks evaluating the crate in GitHub as well.
@cpu cpu marked this pull request as ready for review February 2, 2024 15:37
@cpu cpu merged commit 30feec0 into rustls:main Feb 2, 2024
1 check passed
@cpu cpu deleted the cpu-doc-updates branch February 2, 2024 16:04
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.

None yet

2 participants