Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

[docs-scanner] Sandboxes API tutorial mentions client.get() without showing how to use it

Aperta Adatta ai principianti
  • Qualcosa non va?
#26,224 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia da content/manuals/ai/sandboxes-api/get-started.md e rivedi gli esempi esistenti di client.kits.launchAndWait() e sandbox.delete(). Aggiungi un breve esempio di recupero per client.get(name), oppure inserisci un link a cookbook/find-a-process-you-lost-track-of.md con indicazioni specifiche per il recupero. Il lavoro è completato quando chi legge per la prima volta riesce a identificare il nome del sandbox, recuperarlo e ripulirlo.

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

Descrizione

File: content/manuals/ai/sandboxes-api/get-started.md

Issue

The tutorial tells readers what to do if the program stops unexpectedly, but doesn't show them how:

If the program stops after printing the sandbox name, retrieve the sandbox with client.get(name) and delete it when you're finished.

This is the only mention of client.get() in the tutorial, and there's no example of how to use it. The tutorial shows client.kits.launchAndWait() and sandbox.delete(), but never demonstrates retrieval.

Why this matters

A reader following the tutorial who encounters this failure scenario won't know:

  • What to import or how to call client.get(name)
  • What the name parameter should be (the full sandboxes/<uid> string?)
  • What to do with the returned object
  • Whether they need to check the sandbox state before deleting

The tutorial is aimed at first-time users ("Run your first cloud sandbox"), so they can't be expected to infer the API from this brief mention.

Suggested fix

Add a brief code example showing recovery, either inline or in a collapsed section:

// If the program stopped, retrieve and clean up:
const existing = await client.get('sandboxes/<uid>');
const latest = await existing.refresh();
await latest.delete({ force: true });

Or reference the cookbook with a specific example: "See Find a process you lost track of for recovery steps."

Found by nightly documentation quality scanner

Lingua principale
Markdown
Stelle
4.7k
Fork
8.5k
Merge medio
1g 18h
PR unite (30g)
127

Preparare l'ambiente

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.