Move PGV documentation back into the root README#1012
Merged
nicksnyder merged 2 commits intomainfrom Nov 8, 2023
Merged
Conversation
rodaine
approved these changes
Nov 8, 2023
rodaine
pushed a commit
to bufbuild/protovalidate
that referenced
this pull request
Jan 2, 2024
Move the logo out of the heading to be consistent with other repositories that have a logo (e.g. https://github.com/bufbuild/buf, https://github.com/connectrpc/connect-es), and update the README to be consistent with the language used in [PGV readme](https://github.com/bufbuild/protoc-gen-validate/blob/main/README.md) (see also bufbuild/protoc-gen-validate#1012)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In #938 we moved information about PGV out of the main readme and into a separate file. At the same time, we inlined more information about Protovalidate into the main PGV readme, including directly linking to per-language Protovalidate repositories.
Since then, we have had many instances of confusion on the Protovalidate issue tracker with users asking question about PGV (in part because I think people didn't realize this was a separate project).
To alleviate this confusion, this PR moves PGV documentation back to the main readme while maintaining a clear note at the top about the status of this project as well as the existence of Protovalidate.