Skip to content

Trim the readme down #938

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

Merged
merged 8 commits into from
Aug 14, 2023
Merged

Trim the readme down #938

merged 8 commits into from
Aug 14, 2023

Conversation

elliotmjackson
Copy link
Contributor

reduce readme noise by moving rules to separate docs file: Organize documentation by moving detailed rules to a separate file, simplifying the readme, and providing clear links to the detailed documentation.

@elliotmjackson elliotmjackson requested a review from rodaine August 10, 2023 21:39
@elliotmjackson elliotmjackson marked this pull request as ready for review August 10, 2023 21:39
@elliotmjackson elliotmjackson enabled auto-merge (squash) August 10, 2023 21:40
@elliotmjackson elliotmjackson enabled auto-merge (squash) August 14, 2023 17:34
@elliotmjackson elliotmjackson merged commit fce8e8d into main Aug 14, 2023
@elliotmjackson elliotmjackson deleted the ejackson/remove-readme branch August 14, 2023 17:35
nicksnyder added a commit that referenced this pull request Nov 8, 2023
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 change 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.
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