[PR #227] [MERGED] docs: improve core concepts, use cases, and API reference

bsakaguchi commented

2026-10-29 14:21:40 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/AgentENV/pull/227
Author: @zlzGithub-0801
Created: 8/27/2026
Status: ✅ Merged
Merged: 8/31/2026
Merged by: @yingdi-shan

Base: main ← Head: docs/improve-user-guides

📝 Commits (1)

b4f0f2b docs: improve core concepts, use cases, and API reference

📊 Changes

10 files changed (+397 additions, -88 deletions)

View changed files

📝 docs/src/SUMMARY.md (+5 -0)
📝 docs/src/api/index.md (+29 -15)
📝 docs/src/concepts/authentication.md (+17 -11)
📝 docs/src/concepts/sandboxes.md (+55 -32)
📝 docs/src/concepts/snapshots.md (+7 -0)
📝 docs/src/concepts/templates.md (+18 -0)
➕ docs/src/stoplight-elements.html (+127 -0)
➖ docs/src/swagger-ui.html (+0 -30)
➕ docs/src/use-cases/miles.md (+88 -0)
➕ docs/src/use-cases/python.md (+51 -0)

📄 Description

What

Improve AgentENV documentation by:

Clarifying sandbox lifecycle, timeout, refresh, snapshot, and template operations.
Adding Python, Codex, and Miles use cases.
Replacing Swagger UI with Stoplight Elements.

Why

Important sandbox operations were difficult to find and distinguish. The documentation also lacked practical examples for common AgentENV use cases.

N/A.

Scope and non-goals

Included:

Documentation changes

Not included:

AgentENV behavior changes.

Design and behavior changes

N/A

Compatibility and operations

Public API or generated protocol: N/A — no API definitions changed.
Configuration or defaults: N/A — existing configuration is only documented.
Snapshot manifest, artifact layout, or storage format: N/A.
Upgrade and rollback: N/A — documentation-only change.
Host requirements, permissions, ports, or dependencies: N/A.

Validation

make fmt
make clippy
make test-unit
Relevant Rust integration tests
make -C services test
Generated clients/server regenerated
Documentation updated
Benchmarks or performance comparison completed

Risks and reviewer notes

N/A

Checklist

The PR contains one coherent change and no unrelated refactoring.
Testing is limited to documentation validation because runtime behavior is unchanged.
Logs and examples contain no credentials, tokens, or private registry information.
Generated code was not manually edited.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/kvcache-ai/AgentENV/pull/227 **Author:** [@zlzGithub-0801](https://github.com/zlzGithub-0801) **Created:** 8/27/2026 **Status:** ✅ Merged **Merged:** 8/31/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `docs/improve-user-guides` --- ### 📝 Commits (1) - [`b4f0f2b`](https://github.com/kvcache-ai/AgentENV/commit/b4f0f2bb98160416cd6b769d433ba31f6f9392b5) docs: improve core concepts, use cases, and API reference ### 📊 Changes **10 files changed** (+397 additions, -88 deletions) <details> <summary>View changed files</summary> 📝 `docs/src/SUMMARY.md` (+5 -0) 📝 `docs/src/api/index.md` (+29 -15) 📝 `docs/src/concepts/authentication.md` (+17 -11) 📝 `docs/src/concepts/sandboxes.md` (+55 -32) 📝 `docs/src/concepts/snapshots.md` (+7 -0) 📝 `docs/src/concepts/templates.md` (+18 -0) ➕ `docs/src/stoplight-elements.html` (+127 -0) ➖ `docs/src/swagger-ui.html` (+0 -30) ➕ `docs/src/use-cases/miles.md` (+88 -0) ➕ `docs/src/use-cases/python.md` (+51 -0) </details> ### 📄 Description ## What Improve AgentENV documentation by: - Clarifying sandbox lifecycle, timeout, refresh, snapshot, and template operations. - Adding Python, Codex, and Miles use cases. - Replacing Swagger UI with Stoplight Elements. ## Why Important sandbox operations were difficult to find and distinguish. The documentation also lacked practical examples for common AgentENV use cases. ## Related issue N/A. ## Scope and non-goals Included: - Documentation changes Not included: - AgentENV behavior changes. ## Design and behavior changes N/A ## Compatibility and operations - Public API or generated protocol: N/A — no API definitions changed. - Configuration or defaults: N/A — existing configuration is only documented. - Snapshot manifest, artifact layout, or storage format: N/A. - Upgrade and rollback: N/A — documentation-only change. - Host requirements, permissions, ports, or dependencies: N/A. ## Validation - [ ] `make fmt` - [ ] `make clippy` - [ ] `make test-unit` - [ ] Relevant Rust integration tests - [ ] `make -C services test` - [ ] Generated clients/server regenerated - [x] Documentation updated - [ ] Benchmarks or performance comparison completed ## Risks and reviewer notes N/A ## Checklist - [x] The PR contains one coherent change and no unrelated refactoring. - [x] Testing is limited to documentation validation because runtime behavior is unchanged. - [x] Logs and examples contain no credentials, tokens, or private registry information. - [x] Generated code was not manually edited. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi