Documentation of protobufs is broken with multiline comments
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Bug
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Ambito
- documentation
Direzione di ricerca
Inizia eseguendo make buf nel progetto keto e confronta docs/.generated/proto-api.mdx con protof/buf.md. Poi esamina come il contenuto generato arriva in docs/keto/reference/proto-api.mdx; il lavoro è completo quando i commenti multilinea rimangono compatibili con le tabelle e la documentazione renderizzata non presenta più tabelle corrotte né testo illeggibile.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- TypeScript
- Stelle
- 161
- Fork
- 1.9k
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di ory/docs
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
upstream reference closed: github.com/w3c/webauthn/issues/1372Forse di nuovo libera @Faisal-9999 l’ha presa 53 giorni fa e non c’è nessuna pull request aperta. Apertagood first issue help wanted upstream
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
-
bug
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 78/100
-
good first issue help wanted upstream
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
-
Shared kratos pages can only belong to one sidebar — OEL readers lose navigation contextForse di nuovo libera @hperl l’ha presa 105 giorni fa e non c’è nessuna pull request aperta. Aperta
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
openremote/openremote#3487 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
coollabsio/jean#867 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
ehmpathy/rhachet-roles-bhuild#616 ·
I maintainer di solito rispondono entro 1 giorno
-
📘 Docs supabase/cli
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
I maintainer di solito rispondono entro 1 giorno
-
bug(cli): theme file home-directory check uses startsWith (sibling dirs pass, Windows casing fails)Apertaarea/core kind/bug priority/p2 status/bot-triaged
Difficoltà 2/5 1-3 ore Idoneità per principianti 79/100
google-gemini/gemini-cli#29955 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno