[docs-scanner] Contradictory information about startup commands gating agent entrypoint
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 90/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- docker
調査の方向性
content/manuals/ai/sandboxes/customize/kit-reference.md と content/manuals/ai/sandboxes/customize/kit-examples.md を開き、setup.startup と background の説明を比較します。提案どおりに文言を更新し、コマンドの順序とエージェントのエントリーポイントの動作が区別されるようにして、重複した警告を削除します。両方のセクションに一貫性があり、新しい主張を導入せずにガイダンスが明確になっていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Files:
content/manuals/ai/sandboxes/customize/kit-reference.mdcontent/manuals/ai/sandboxes/customize/kit-examples.md
Issue
Two files in the same directory give contradictory information about whether setup.startup commands gate the agent's entrypoint.
In kit-reference.md, the startup section states:
Startup commands are non-interactive. They run before the agent attaches, with no terminal connected, so they can't prompt the user (for example, an interactive
aws loginwill hang or fail). They also don't gate the agent's entrypoint: the agent launches once startup commands have been dispatched, regardless ofbackground. A value offalsewaits within the startup dispatcher before it runs the next command; it doesn't delay the agent entrypoint.
But in kit-examples.md, the "Customize agent settings" section warns:
Agent settings mechanisms differ. If an agent doesn't support an additional config file, launch option, or environment variable for the setting, kits can't replace the sandbox-managed user settings before the agent launches.
setup.startupdoesn't gate the agent entrypoint, so don't use it for settings the agent must read during initialization.
The first quote explains the behavior in detail. The second quote repeats the same fact but in a warning context that suggests this is a limitation readers need to work around. However, both are saying the same thing - startup commands don't block the agent from starting.
The confusion is compounded because the background: false description in kit-reference.md says:
Block later startup commands until this command finishes. Set to
trueto let later commands run without waiting.
This makes it sound like background: false creates blocking behavior, but then the text immediately clarifies that this blocking only affects other startup commands, not the agent entrypoint. A reader could easily misunderstand this sequence.
Why this matters
A reader trying to understand when their startup commands will complete relative to agent launch will get conflicting signals. The detailed explanation in kit-reference.md is correct, but the way background: false is described ("Block later startup commands") followed by the clarification creates unnecessary confusion. The warning in kit-examples.md repeats the same fact without adding new information, making readers wonder if they missed something.
Suggested fix
-
In
kit-reference.md, rewrite thebackgroundfield description to lead with what it does, not what it blocks:Current:
Block later startup commands until this command finishes. Set to
trueto let later commands run without waiting.Suggested:
Run this command in the background. When
false(default), the startup dispatcher waits for this command to finish before running the next startup command. Whentrue, the dispatcher continues immediately. Neither setting delays the agent entrypoint. -
In
kit-examples.md, remove the redundant warning sentence since the limitation is already explained in the reference. Keep only the actionable guidance:Current:
Agent settings mechanisms differ. If an agent doesn't support an additional config file, launch option, or environment variable for the setting, kits can't replace the sandbox-managed user settings before the agent launches.
setup.startupdoesn't gate the agent entrypoint, so don't use it for settings the agent must read during initialization.Suggested:
Agent settings mechanisms differ. If an agent doesn't support an additional config file, launch option, or environment variable for the setting, kits can't replace the sandbox-managed user settings before the agent launches.
Found by nightly documentation quality scanner
- 主要言語
- Markdown
- スター
- 4.7k
- フォーク
- 8.5k
- 平均マージ
- 2日 16時間
- マージ済み PR(30日)
- 107
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
docker/docs のほかの issue
-
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
-
status/triage
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
似ている issue
-
sync-en
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
agilepathway/label-checker#640 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
BasedHardware/omi#15662 · コメント 1 件 ·
-
documentation help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
-
documentation good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
amponce/archive-movie-browser#167 ·