ory / ory/docs

Documentation of protobufs is broken with multiline comments

Open
#1,537 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug upstream
Dominant language
TypeScript
Stars
161
Forks
1.9k
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running make buf in the keto project and compare docs/.generated/proto-api.mdx with protof/buf.md. Then inspect how the generated content reaches docs/keto/reference/proto-api.mdx; done means multiline comments remain table-safe and the rendered documentation no longer has broken tables or garbled text.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.