Repository navigation
docs: Protobuf schema docs shard from protoc source info (closes #9824) - #9953
Merged
Merged
Conversation
protobuf_doc_shard runs the protoc of the registered proto toolchain with --include_source_info over a proto_library's own sources and converts the descriptor set to a DocIr shard with a new Rust extractor. Messages map to classes, fields to fields, enums and values to enums and variants, services to interfaces and rpcs to methods; map fields show as maps and streaming rpcs are marked. The docs aspect adds shards for proto_library targets. Avro is split out to #9936. Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_01Xut2hwESun1HL2eSVd1d5B
TrapsterDK
force-pushed
the
protobuf-docs-shard
branch
from
November 9, 2026 16:27
0549140 to
3312665
Compare
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.
Closes #9824 (Protobuf). Avro schema docs are split out to #9936.
protobuf_doc_shard(proto, package)runs the protoc of the registered proto toolchain (optional@protobuf//bazel/private:proto_toolchain_type, so it resolves on every platform) with--include_source_info, then a new Rust extractor (tools/docs/protobuf/extract) turns the descriptor set into a DocIr shard. protoc-gen-doc was rejected: it is an unmaintained Go binary that only re-prints the comments protoc already keeps.member_ofand dotted ids;map<K, V>fields shown as maps with entry messages hidden; streaming rpcs saystream.docsaspect branch forproto_library, fixture with two protos (import, timestamp, service, enum, map), real aspect subject,languages.bzldoc tool,docs.mdrow, generation README paragraph, regenerated support matrix, crate registered and locks repinned with Bazel.Tested: extractor unit tests,
//tools/docs/protobuf:shard_test,//quality/testdata:real_docs_shards, support_matrix facts/generate tests.macro_rows_testfails with "BENCH is not a dict", which this change does not touch. Nested-Bazel and consumer tests were not run.🤖 Generated with Claude Code
https://claude.ai/code/session_01Xut2hwESun1HL2eSVd1d5B