Documentation of protobufs is broken with multiline comments
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng cách chạy make buf trong dự án keto và so sánh docs/.generated/proto-api.mdx với protof/buf.md. Sau đó kiểm tra cách nội dung được tạo ra được đưa vào docs/keto/reference/proto-api.mdx; hoàn tất khi các chú thích nhiều dòng vẫn an toàn cho bảng và tài liệu được kết xuất không còn bảng bị hỏng hoặc văn bản bị lỗi.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- TypeScript
- Star
- 161
- Fork
- 1.9k
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của ory/docs
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
-
upstream reference closed: github.com/w3c/webauthn/issues/1372Có thể làm lại được @Faisal-9999 đã nhận 60 ngày trước và không có pull request nào đang mở. Đang mởgood first issue help wanted upstream
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 72/100
-
bug
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 78/100
-
good first issue help wanted upstream
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Shared kratos pages can only belong to one sidebar — OEL readers lose navigation contextCó thể làm lại được @hperl đã nhận 112 ngày trước và không có pull request nào đang mở. Đang mở
Issue tương tự
-
triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
Maintainer thường phản hồi trong vòng 1 ngày
-
🎙️ task - drop the raw `./node_modules/.bin/rhachet roles boot` line from bhuild's feedback templateĐang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
ehmpathy/rhachet-roles-bhuild#639 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
e2e-failure ready-to-code
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
redhat-developer/rhdh-plugin-export-overlays#4650 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 62/100
Maintainer thường phản hồi trong vòng 13 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
omdsh-dev/DSH-better-sidebar#1098 ·
Maintainer thường phản hồi trong vòng 2 ngày