teabot opened a new issue, #17258: URL: https://github.com/apache/pulsar/issues/17258
### Search before asking - [X] I searched in the [issues](https://github.com/apache/pulsar/issues) and found nothing similar. ### What issue do you find in Pulsar docs? The [binary protocol specification documentation](https://pulsar.apache.org/docs/next/developing-binary-protocol/) is incomplete. For example, it does not cover in any great detail `RedeliverUnacknowledgedMessages` or transaction. This document should serve as the canonical description of all interactions with Pulsar brokers. ### What is your suggestion? I would suggest the following approach to resolve the issue: 1. Define a MVP for documenting a protocol command: 1. Textual description of command 2. Tabular description of all attributes, including defaults, value validations, example values, and textual description 3. Enumeration of key use-cases that involve the command 4. Description of each use case with corresponding sequence diagram showing client-broker interaction 2. Audit [current documentation](https://pulsar.apache.org/docs/next/developing-binary-protocol/) with respect to the aforementioned MVP to understand existing documentation coverage. 3. Audit [protobuf binary protocol](https://github.com/apache/pulsar/blob/master/pulsar-common/src/main/proto/PulsarApi.proto) to help understand undocumented commands. 4. Create issues for each under/un-documented command to create relevant documentation for said command. 5. Work on each created issue. ### Any reference? _No response_ ### Are you willing to submit a PR? - [X] I'm willing to submit a PR! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
