docs: contributor-facing documentation cleanup (typos + stale links)#617
Merged
fruffy merged 1 commit intoJul 4, 2026
Merged
Conversation
Signed-off-by: Devansh-567 <devansh.jay.singh@gmail.com>
fruffy
approved these changes
Jul 2, 2026
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
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.
Summary
Full pass over the contributor-facing docs (root README, CONTRIBUTING,
docs/,docs/v1/,rust/) to fix typos and stale/incorrect links encountered while onboarding to the build, release, codegen, Rust, Python, and Bazel workflows. No behavioral, code, or protobuf changes, text only.What changed
Typos
resepectively→respectively(docs/README.md,docs/v1/README.md)apparrent→apparent(docs/v1/README.md)navgiate→navigate(rust/README.md)postive→positive(docs/v1/guidance-for-generating-p4info.md)mssages→messages(docs/v1/p4runtime-id-notes.md)docs/tools/README.md)`p4lang/p4rt-asciidoc:latest` Docker` image→`p4lang/p4rt-asciidoc:latest` Docker image(docs/v1/README.md)Capitalization / naming consistency
Github→GitHubeverywhere it appears as the product name (README.md,docs/README.md,CONTRIBUTING.md)Stale / outdated links
README.md: the three "Guidelines for using Protocol Buffers" links pointed atdevelopers.google.com/protocol buffers/docs/..., which has been superseded byprotobuf.dev. Updated to:https://protobuf.dev/overview/#updating-defshttps://protobuf.dev/programming-guides/proto3/#updatinghttps://protobuf.dev/programming-guides/proto3/#backwarddocs/README.md: the "latest working draft" spec link pointed athttps://p4.org/p4runtime/spec/main/P4Runtime-Spec.html, which doesn't resolve. Replaced with the actual GitHub Pages URL already used elsewhere in the repo:https://p4lang.github.io/p4runtime/spec/main/P4Runtime-Spec.html.docs/v1/README.md: the P4.org specifications page link pointed athttps://p4.org/specs, which has moved tohttps://p4.org/specifications/.Files changed
README.mdCONTRIBUTING.mddocs/README.mddocs/tools/README.mddocs/v1/README.mddocs/v1/guidance-for-generating-p4info.mddocs/v1/p4runtime-id-notes.mdrust/README.mdWhy this shape
This started from a couple of visible typos but turned into a full pass because contributor docs are one of the first things new contributors read before touching build/release/codegen/Rust/Python/Bazel workflows, small inconsistencies (broken links, "Github" vs "GitHub", duplicated words) add up and erode trust in the docs. Kept strictly to wording/links; no changes to
.protofiles, generated code, or CI.Testing
Github(mis-capitalized) to confirm no other occurrences remain.Not included (follow-up candidates, kept out to stay reviewable)
docs/tools/README.mdalso says "push the image to dockerhub" could be restyled to "Docker Hub" for consistency, left as-is since it's a style choice, not a typo.py/README.md(it is a symlink to the rootREADME.md, so there's nothing to edit there independently).