[docs-scanner] Contradictory information about startup commands gating agent entrypoint

Aperta Adatta ai principianti
#26,005 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
90/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
docker
Ambito
documentation

Direzione di ricerca

Apri content/manuals/ai/sandboxes/customize/kit-reference.md e content/manuals/ai/sandboxes/customize/kit-examples.md, quindi confronta le descrizioni di setup.startup e background. Aggiorna la formulazione come proposto, in modo che l’ordine dei comandi e il comportamento dell’entrypoint dell’agente siano distinti chiaramente, e rimuovi l’avviso ridondante. Il lavoro è completato quando entrambe le sezioni sono coerenti e le indicazioni sono chiare senza introdurre nuove affermazioni.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Files:

  • content/manuals/ai/sandboxes/customize/kit-reference.md
  • content/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 login will hang or fail). They also don't gate the agent's entrypoint: the agent launches once startup commands have been dispatched, regardless of background. A value of false waits 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.startup doesn'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 true to 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
  1. In kit-reference.md, rewrite the background field description to lead with what it does, not what it blocks:

    Current:

    Block later startup commands until this command finishes. Set to true to 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. When true, the dispatcher continues immediately. Neither setting delays the agent entrypoint.

  2. 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.startup doesn'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

Lingua principale
Markdown
Stelle
4.7k
Fork
8.5k
Merge medio
2g 12h
PR unite (30g)
104

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di docker/docs

Tutte le issue di docker/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.