Motivation

Protobuffet is intended for builders and consumers of Protobuf service implementations.

Documentation reduces the barrier for users to consume your APIs. As a builder, writing consistent, accurate documentation is difficult and often impacts developer velocity. The community is transitioning to services exposed by Protobuf contracts, but unfortunately the documentation toolset that we used to rely on for JSON APIs is no longer applicable. Protobuffet aims to solve this need for consistent, accurate documentation that satisfies both the builders and consumers of APIs driven by Protobuf contracts.

Use Protobuffet if:

• ✅ You build or consume a set of APIs driven by Protobuf contracts.
• ✅ You rely on Protobuf contracts for data de/serialization.
• ✅ You require an enhanced version of Protobuf documentation compared to what is offered today.
• ✅ You believe documentation should be driven by code and auto-generated.
• ✅ You are willing to leverage the Docusaurus framework.