Skip to content

Prepare GitHub docs for shift to buf.build/docs #238

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

Conversation

jrinehart-buf
Copy link
Contributor

@jrinehart-buf jrinehart-buf commented Feb 25, 2025

Note: Do not merge. This cannot be merged until Protovalidate documentation is live on buf.build/docs.

Notes for reviewers:

  • There are no code changes here: purely Markdown. It's probably easiest to view the updates pages by opening the branch in a second browser tab.

This PR:

  • Updates the README for protovalidate-java to be in "hierarchy of developer needs" order intended to be consistent across all Protovalidate repositories:
    1. What's Protovalidate?
    2. How do I install it or find support for my language? (Supported Languages)
    3. How do I use it? (Documentation)
    4. How do I contribute? (Contribution)
    5. Related Sites
    6. Legal
  • Updates bug report template to list Protovalidate before protoc-gen-validate

@jrinehart-buf jrinehart-buf changed the title Jrinehart/dvrl 60 update protovalidate java repository Prepare GitHub docs for shift to buf.build/docs Feb 25, 2025
# [![The Buf logo](.github/buf-logo.svg)][buf] protovalidate-java
[![The Buf logo](.github/buf-logo.svg)][buf]

# protovalidate-java
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At some point we should add some more badges to this README including the latest version number and potentially a link to published Javadocs.

@jrinehart-buf jrinehart-buf merged commit ffcf02f into main Apr 3, 2025
4 checks passed
@jrinehart-buf jrinehart-buf deleted the jrinehart/dvrl-60-update-protovalidate-java-repository branch April 3, 2025 19:11
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.

3 participants