Skip to content

Conversation

@jrinehart-buf
Copy link
Contributor

The package docs page for Protovalidate is the currently the third result if you do a Google search for "Protovalidate," but it doesn't provide any introductory text.

This PR uses a package-level comment to:

  1. Adds the opening from its README.md file
  2. Respects that this is package documentation ("This package provides the options, messages, and enums that power Protovalidate...")
  3. Including a terse example
  4. Provide links to both docs and all Protovalidate runtimes

Testing:

  1. I've used a private repo to make sure it renders correctly:
    image
  2. I've used the playground to make sure the abbreviated proto compiles and validates correctly.

@github-actions
Copy link

github-actions bot commented Dec 4, 2025

The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedDec 5, 2025, 5:17 PM

@jrinehart-buf jrinehart-buf marked this pull request as draft December 4, 2025 20:24
@jrinehart-buf jrinehart-buf marked this pull request as ready for review December 5, 2025 17:17
@smallsamantha smallsamantha merged commit 4502bb9 into main Dec 11, 2025
7 checks passed
@smallsamantha smallsamantha deleted the jrinehart/dvrl-633-add-package-documentation-for-protovalidate branch December 11, 2025 15:08
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.

4 participants