Skip to content

docs: add sandbox, PTY, and process API documentation#20

Merged
changkun merged 1 commit into
mainfrom
changkun/docs-update
Apr 7, 2026
Merged

docs: add sandbox, PTY, and process API documentation#20
changkun merged 1 commit into
mainfrom
changkun/docs-update

Conversation

@changkun

@changkun changkun commented Apr 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Update README.md: add sandbox quickstart, PTY WebSocket example, process management example, lifecycle (suspend/resume/snapshot), SSE follow, custom endpoints section, examples section
  • Add docs/sandbox-apis.md: comprehensive documentation for all sandbox APIs (management, files, PTY, processes) with code examples
  • Update docs/README.md: add sandbox API reference tables and quick navigation links
  • Update doc.go: package description now mentions sandbox capabilities

Changes

File What changed
README.md +3 features, +sandbox section with 5 code examples, +examples section
doc.go Package description expanded
docs/sandbox-apis.md New file: ~300 lines covering all sandbox APIs
docs/README.md +4 API reference tables (management, files, PTY, processes)

- Update README with sandbox quickstart, PTY example, process example,
  lifecycle management, SSE follow, and custom endpoint configuration
- Add docs/sandbox-apis.md covering all sandbox management, file,
  PTY, and process APIs with code examples
- Update docs/README.md index with sandbox API reference tables
- Update doc.go package description to mention sandbox capabilities
@changkun changkun merged commit e536ded into main Apr 7, 2026
4 checks passed
@changkun changkun deleted the changkun/docs-update branch April 7, 2026 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant