Keto documentation seems outdated and incomplete
@unatasha8 がすでに取り組んでいます。
2025年11月20日 から。
評価
この 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.
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.
- 主要言語
- TypeScript
- スター
- 161
- フォーク
- 1.9k
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
ory/docs のほかの issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
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 が 78 日前に担当しましたが、オープン中のプルリクエストはありません。 オープン
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
openedx/frontend-app-authoring#3274 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
-
area/documentation status/need-triage
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
google-gemini/gemini-cli#29548 ·
メンテナーはふだん 1 日以内に返信
-
sdk-typescript vector-store
難易度 2/5 半日 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信