title: "protodocs.dev"
logo_text: "protodocs.dev"
default_tab: "files"
descriptor_files:
  - "/eliza.binpb"
  - "/googleapis.binpb"
  - "/protovalidate.binpb"
  - "/wellknowntypes.binpb"
  - "/config.binpb"
service_endpoints:
  connectrpc.eliza.v1.ElizaService:
    endpoints:
      - "https://demo.connectrpc.com"
protocols:
  - connect
  - grpc
  - grpc-web
prioritized_paths:
  - "protodocs/v1"
  - "google/protobuf"
highlighted_files:
  - "protodocs/v1/config.proto"
  - "google/protobuf/descriptor.proto"
front_page_sections:
  - type: markdown
    markdown: |
      # Welcome to ProtoDocs

      **ProtoDocs** is a client-side interactive documentation explorer for Protocol Buffer schemas. It translates compiled binary descriptors or live server reflection maps into human-readable, cross-linked, and syntax-highlighted specifications. The project is open-source and hosted on [GitHub](https://github.com/sudorandom/protodocs).

      ProtoDocs provides a rich interactive interface to:
      - **Browse Files & Packages**: Clean directory hierarchy merging common path prefixes.
      - **Analyze Services & RPCs**: Renders service signatures alongside custom method options.
      - **Inspect Messages, Enums & Custom Options**: Renders structured types with interactive type links, oneof declarations, and nested custom options with full comment support.
      - **Go to Definition & Find References**: Pin tooltips to jump directly to type declarations and find all usages across loaded files.
      - **Interactive Try it out Client**: Send live gRPC-Web and Connect RPC requests to target services directly from the browser.
      - **Dynamic CLI Command Snippets**: Generates ready-to-use Connect and gRPC `curl` or `buf curl` command line snippets.

      ### Core Schema Definitions
      Explore the core definitions of Protocol Buffers by visiting the [google/protobuf/descriptor.proto](/#/files/google/protobuf/descriptor.proto) file.

      *Select a file or service on the sidebar to explore the schema.*
  - type: deployment-diagram-panel
  - type: descriptor-stats-panel
  - type: type-reference-stats-panel
  - type: service-list-panel
  - type: markdown-small
    markdown: |
      `protodocs` is an open-source project for rendering reference documentation from protobuf descriptors.

      **GitHub Repository:** [github.com/sudorandom/protodocs](https://github.com/sudorandom/protodocs)

      &copy; 2026 protodocs.dev. All rights reserved.
