Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open Beginner friendly
  • Is something wrong?
#26,224 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@nielskaspers is already working on this.

Since Sep 30, 2026.

  • #26226 by @nielskaspers — open

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

Start in content/manuals/ai/sandboxes-api/get-started.md and review the existing client.kits.launchAndWait() and sandbox.delete() examples. Add a brief recovery example for client.get(name), or link to cookbook/find-a-process-you-lost-track-of.md with specific recovery guidance. Done means first-time readers can identify the sandbox name, retrieve it, and clean it up.

Written by the indexing model from the issue text.

Description

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

Dominant language
Markdown
Stars
4.7k
Forks
8.5k
Avg merge
1d 18h
Merged PRs (30d)
120

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from docker/docs

All issues in docker/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.