Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte Adaptée aux débutants
  • Quelque chose ne va pas ?
#26,224 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@nielskaspers y travaille déjà.

Depuis le 30/9/2026.

  • #26226 par @nielskaspers — ouverte

Évaluation

Difficulté
1/5
Temps estimé
1-3 heures
Accessibilité débutants
88/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
typescript
Domaine
documentation

Piste de recherche

Commencez dans content/manuals/ai/sandboxes-api/get-started.md et examinez les exemples existants de client.kits.launchAndWait() et sandbox.delete(). Ajoutez un bref exemple de récupération pour client.get(name), ou créez un lien vers cookbook/find-a-process-you-lost-track-of.md avec des indications précises pour la récupération. La tâche est terminée lorsque les lecteurs qui découvrent le contenu peuvent identifier le nom du sandbox, le récupérer et le nettoyer.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

area/ai status/confirmed

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

Langage dominant
Markdown
Étoiles
4.7k
Forks
8.5k
Merge moyen
1 j 22 h
PR mergées (30 j)
133

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de docker/docs

Toutes les issues de docker/docs

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.