Overview

Protobuffet is a documentation environment for your Protobuf file workspace.

Documentation should be driven by the code that it documents, but easily extensible through a structured framework. Protobuf contracts help document objects and exposed APIs for your services. These contracts alone provide many benefits, but gaps still remain in the documentation requirements of these services. Protobuffet provides the toolset to build complete documentation of your Protobuf file workspace.

Our documentation starts with an enhanced view of Protobuf contracts. The Protobuffet CLI parses your Protobuf file workspace to generate modern documentation pages for your organization. This automated, granular documentation is deep linked and extensible with our toolset.

View the example workspace for a preview of the generated documentation.