Documentation of protobufs is broken with multiline comments

[constantoine]

Preflight checklist

• I could not find a solution in the existing issues, docs, nor discussions.
• I agree to follow this project's Code of Conduct.
• I have read and am following this repository's Contribution Guidelines.
• I have joined the Ory Community Slack.
• I am signed up to the Ory Security Patch Newsletter.

Ory Network Project

No response

Describe the bug

Documentation generated from protobuf files which contain a newline will generate a broken table.

Reproducing the bug

run: make buf inside the keto project. The generated file docs/.generated/proto-api.mdx is well formated. Tables contain newlines with </br> tags. The file protof/buf.md does not.

Open the docs/keto/reference/proto-api.mdx file inside the docs project. The tables now contain actual newlines, breaking the tables, and resulting in garbled docs

Relevant log output

No response

Relevant configuration

No response

Version

keto v0.11.1-alpha.0

On which operating system are you observing this issue?

None

In which environment are you deploying?

None

Additional Context

No response

[constantoine]

I believe the issue is caused by the buf tool. I'm looking into ways of configuring this, but the docs of buf are not helping a lot for markdown table generation

[constantoine]

Caused by pseudomuto/protoc-gen-doc#274