Documentation of protobufs is broken with multiline comments
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 35/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
調査の方向性
まず keto プロジェクトで make buf を実行し、docs/.generated/proto-api.mdx と protof/buf.md を比較します。次に、生成されたコンテンツがどのように docs/keto/reference/proto-api.mdx に反映されるかを確認します。マルチラインコメントがテーブルで安全な状態を保ち、レンダリングされたドキュメントに壊れたテーブルや文字化けしたテキストがなくなれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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
- 主要言語
- TypeScript
- スター
- 161
- フォーク
- 1.9k
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ory/docs のほかの issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
upstream reference closed: github.com/w3c/webauthn/issues/1372再び着手できるかも @Faisal-9999 が 53 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンgood first issue help wanted upstream
難易度 1/5 1〜3時間 初心者へのやさしさ 72/100
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
-
good first issue help wanted upstream
難易度 1/5 1〜3時間 初心者へのやさしさ 72/100
-
Shared kratos pages can only belong to one sidebar — OEL readers lose navigation context再び着手できるかも @hperl が 105 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
似ている issue
-
a10y a10y-audit ai-driven-qa claude
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
linagora/twake-directory-manager#219 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 79/100
メンテナーはふだん 1 日以内に返信
-
0️⃣ phase/new
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
Pulse v7: buildPreferencesFromTelos() bypasses telosSectionOrFile(), renders empty on unified-TELOS installs対応中かも @zephyr91 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
danielmiessler/LifeOS#2393 ·
メンテナーはふだん 4 日以内に返信