Schema documentation – Overview

The Buf Schema Registry (BSR) generates documentation from the Protobuf comments for each module, enabling you to view the module's .proto files in source code view with an organized UI and navigate easily between them. It also allows schema publishers to add module and package information to provide additional context and usage details.

To view the documentation for any BSR module, go to its Docs tab:

To click around an example, see the connectrpc/eliza module.

Module documentation

When you first go to the module documentation, there are links into each of its packages, and any module documentation that the schema owner has provided.

When you click into a package, you see the package docs at the top, an index of the entities categorized by field type on the left, and the entities themselves in the same order on the right:

Clicking in the index takes you to the referenced item, and you can quickly navigate from the docs to the Protobuf file by clicking the filename on the right side of each entity. Each entity's header also has a unique anchor tag that you can click to copy, enabling you to share a link to the exact item.

Related docs

• See Adding documentation to learn how to set up documentation for BSR modules.