docs: reorganize developer documentation
This commit is contained in:
+27
-10
@@ -1,14 +1,31 @@
|
||||
# manifest
|
||||
|
||||
Pod の宣言的設定を TOML マニフェストとして定義・パースするクレート。モデル設定、ワーカー設定、ディレクトリスコープ制約を記述できる。
|
||||
## Role
|
||||
|
||||
## 公開型
|
||||
`manifest` resolves reusable profile/configuration inputs into the concrete runtime Manifest used to create or restore Pods.
|
||||
|
||||
- `PodManifest` — Pod 設定全体(`from_toml()` でパース)
|
||||
- `PodMeta` — Pod メタデータ(名前、pwd)
|
||||
- `ModelConfig` — LLM モデル設定(scheme、base_url、model_id、auth)
|
||||
- `SchemeKind` — wire scheme 種別(`Anthropic`, `OpenaiChat`, `OpenaiResponses`, `Gemini`)
|
||||
- `AuthRef` — 認証参照(`None`, `ApiKey { env, file }`, `CodexOAuth`)
|
||||
- `WorkerManifest` — ワーカー設定(システムプロンプト、生成設定、reasoning)
|
||||
- `ScopeConfig` / `ScopeRule` / `Permission` — allow / deny の宣言的スコープ設定
|
||||
- `Scope` — 実行時スコープ。`from_config(&ScopeConfig, pwd)` で構築し、`is_readable` / `is_writable` / `permission_at` で問い合わせる
|
||||
## Boundaries
|
||||
|
||||
Owns:
|
||||
|
||||
- Profile and Manifest data structures
|
||||
- source/partial/resolved configuration layering
|
||||
- path and prompt-resource resolution
|
||||
- tool permission and filesystem scope configuration types
|
||||
- model/provider references as configuration records
|
||||
|
||||
Does not own:
|
||||
|
||||
- provider HTTP clients or secret lookup implementation (`provider`, `secrets`)
|
||||
- Pod lifecycle (`pod`)
|
||||
- product CLI parsing (`yoi`)
|
||||
- generated memory records (`memory`)
|
||||
|
||||
## Design notes
|
||||
|
||||
Profiles are reusable recipes; resolved Manifests are runtime contracts. Keep runtime-bound fields such as Pod name, concrete delegated scope, sockets, session pointers, and raw secrets out of reusable Profiles.
|
||||
|
||||
## See also
|
||||
|
||||
- [`../../docs/design/profiles-manifests-prompts.md`](../../docs/design/profiles-manifests-prompts.md)
|
||||
- [`../../docs/design/tool-permissions-scope.md`](../../docs/design/tool-permissions-scope.md)
|
||||
|
||||
Reference in New Issue
Block a user