Skip to content

Documentation of protobufs is broken with multiline comments #1537

Open
@constantoine

Description

@constantoine

Preflight checklist

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething is not working.upstreamIssue is caused by an upstream dependency.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions