Skip to content

docs: schema docs for Protobuf with protoc-gen-doc and Avro #9824

Closed

Description

@TrapsterDK

Where

  • tools/docs/support_matrix/languages.bzl:130-166: DOC_TOOLS is None for protobuf and avro, so the API docs column says no.
  • dx docs has no shard for it: shards live in tools/docs/<lang>/defs.bzl (for example tools/docs/jvm/defs.bzl:101), are selected by tools/docs/aspect.bzl, and are listed in docs/cli/commands/docs.md:84.

Fix

  • Protobuf: run protoc-gen-doc through the pinned protoc. Avro: pick a maintained schema doc generator; if none exists, set the cell to n/a with a reason instead.
  • Add <lang>_doc_shard in a new tools/docs/<lang>/defs.bzl, wire it into tools/docs/aspect.bzl so dx docs finds the library with no setup, and add a fixture like tools/docs/jvm/fixture/BUILD.bazel.
  • Pin the tool hermetically on every platform the language supports. If a platform cannot run it, record the reason in the support record.
  • Set the DOC_TOOLS entry, add the row to docs/cli/commands/docs.md and the language README, and run bazel run //tools/docs/support_matrix:update.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Xut2hwESun1HL2eSVd1d5B

Activity

  1. added
    P2Improve and finish existing features
    model:sonnetAgent lane: scoped change with stated design, Sonnet
    on Nov 9, 2026
  2. TrapsterDK commented on Nov 9, 2026

    @TrapsterDK
    CollaboratorAuthor

    PR #9953 uses protoc with --include_source_info (not protoc-gen-doc) and a Rust DocIr extractor; Avro moved to #9936.

    🤖 Generated with Claude Code

    https://claude.ai/code/session_01Xut2hwESun1HL2eSVd1d5B

  3. added a commit that references this issue on Nov 9, 2026
    3312665
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2Improve and finish existing featuresmodel:sonnetAgent lane: scoped change with stated design, Sonnet

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions