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

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

jrinehart-buf
Copy link

@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-python 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 other Markdown files in this repo to:
    • Where necessary, provide "This page has moved..." style pointers to new pages in buf.build/docs.
    • Use a consistent title format with the Buf logo

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