Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#26,224 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@nielskaspers ya está trabajando en esto.

Desde el 30/9/2026.

  • #26226 de @nielskaspers — abierto

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript
Área
documentation

Línea de trabajo

Empieza en content/manuals/ai/sandboxes-api/get-started.md y revisa los ejemplos existentes de client.kits.launchAndWait() y sandbox.delete(). Añade un ejemplo breve de recuperación para client.get(name), o enlaza a cookbook/find-a-process-you-lost-track-of.md con indicaciones específicas para la recuperación. La tarea estará terminada cuando los lectores que consultan el contenido por primera vez puedan identificar el nombre del sandbox, recuperarlo y limpiarlo.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Markdown
Estrellas
4.7k
Forks
8.5k
Merge medio
3 d 1 h
PR fusionados (30 d)
134

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de docker/docs

Todos los issues de docker/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.