Keto documentation seems outdated and incomplete
@unatasha8 ya está trabajando en esto.
Desde el 20/11/2025.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
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.
Describe the bug
Hi! The list I'm about to share might seem like a lot of complaining, but I'm fresh to Keto (and Ory in general) and I figured it might be worth sharing this perspective from an outsider.
To sum it up, the impression the docs give me after spending an afternoon combing through them is that Keto doesn't seem mature enough to depend upon, which I'm sure is something that is untrue and an impression you'd like to avoid. I hope I don't come across as too blunt, this is not a value judgment nor is it intended as a snipe.
Besides #2106, the docs suffer from the following issues:
- There is no explanation on how to apply your permission model to a keto instance. You might write a your
permissions.ts, but what then? - There is no documentation on how to update a permission model either, nor best practices in doing so.
- The configuration options are poorly documented
- $schema seems to assume you know what it's for.
- Listen files are not documented, nor is their use-case
- There is no minimal configuration that will allow you to get started with your own project (apart from if you dig into the outdated cat-videos-example), leaving the user confused on which options are actually required.
- The configuration editor is broken, all fields are read-only (at least in Firefox)
- Installation section seems to be more of a "How to get binaries" section. Nowhere does it mention, for example, that database migrations need to be ran before starting the main server
- macOS instructions seem to suggest the keto executable name is
undefined - Under Self-Hosted->Reference->SDK, there are inexplicably 2 entries. "Ory Keto SDK" and "Go".
- There is documentation and some code samples for List API and Expand API, but not the permission check itself]
- It is unclear whether the Zanzibar is actually used anywhere in Keto itself and needs to be learned, or if it's just present in some of the documentation, since it doesn't seem to be used in the API at all and it isn't intuitive to read.
Reproducing the bug
Try to get started with Keto as a developer without prior experience.
- Lenguaje dominante
- TypeScript
- Estrellas
- 161
- Forks
- 1.9k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de ory/docs
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
good first issue help wanted upstream
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
-
good first issue help wanted upstream
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
-
Shared kratos pages can only belong to one sidebar — OEL readers lose navigation contextQuizá libre de nuevo @hperl la tomó hace 80 días y no hay ningún pull request abierto. Abierto
Issues similares
-
bug via-triage
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
pingdotgg/t3code#14452 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
solana-foundation/program-examples#747 · 1 comentario ·
Los mantenedores suelen responder en 9 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
remotion-dev/remotion#11847 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
openwatersio/slackwater#355 ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
melgarafael/DeskcommCRM#1998 · 3 comentarios ·
Los mantenedores suelen responder en 1 día