[PR #212] [MERGED] docs: refocus core concepts on user workflows

bsakaguchi commented

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

Owner

📋 Pull Request Information

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

Base: main ← Head: docs/user-focused-core-concepts

📝 Commits (1)

90271bf docs: refocus core concepts on user workflows

📊 Changes

17 files changed (+936 additions, -530 deletions)

View changed files

📝 docs/src/SUMMARY.md (+6 -10)
➕ docs/src/concepts/authentication.md (+220 -0)
📝 docs/src/concepts/custom-extension.md (+67 -32)
📝 docs/src/concepts/overview.md (+59 -34)
📝 docs/src/concepts/proxy.md (+23 -8)
📝 docs/src/concepts/sandboxes.md (+309 -71)
📝 docs/src/concepts/snapshots.md (+110 -177)
📝 docs/src/concepts/templates.md (+54 -58)
📝 docs/src/configuration/env-vars.md (+1 -1)
📝 docs/src/deployment/kubernetes.md (+3 -2)
📝 docs/src/deployment/static-multi-node.md (+11 -0)
📝 docs/src/getting-started/aenv-cli.md (+28 -13)
📝 docs/src/internals/architecture.md (+13 -0)
📝 docs/src/internals/networking.md (+3 -1)
📝 docs/src/internals/persistence-artifact-inventory.md (+29 -0)
➖ docs/src/security/authentication.md (+0 -61)
➖ docs/src/security/secure-sandboxes.md (+0 -62)

📄 Description

What

Reorganize AgentENV documentation around user workflows and CLI operations.

This PR:

Reorganizes the docs.
Revises the Core Concepts documentation for templates, sandboxes, snapshots, custom extensions, proxying, and authentication.
Removes Developer Internals from the public documentation navigation.

Why

The existing documentation focused heavily on implementation details while providing limited guidance for users operating AgentENV.

N/A

Scope and non-goals

Included:

Documentation.

Not included:

AgentENV behavior changes.

Design and behavior changes

N/A

Compatibility and operations

Public API or generated protocol: N/A
Configuration or defaults: N/A
Snapshot manifest, artifact layout, or storage format: N/A
Upgrade and rollback: N/A
Host requirements, permissions, ports, or dependencies: No AgentENV runtime changes. Reading the internal mdBook locally requires mdbook and mdbook-mermaid.

Validation

make fmt
make clippy
make test-unit
Relevant Rust integration tests
make -C services test (required when services/ changes)
Generated clients/server regenerated with the documented make target
Documentation updated
Benchmarks or performance comparison completed

Risks and reviewer notes

Checklist

The PR contains one coherent change and no unrelated formatting or refactoring.
New behavior is covered by tests, or I explained why testing is impractical.
Logs and examples contain no credentials, tokens, or private registry information.
I did not manually edit generated code without updating its source and regenerating it.

_{🔄 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/212 **Author:** [@zlzGithub-0801](https://github.com/zlzGithub-0801) **Created:** 8/24/2026 **Status:** ✅ Merged **Merged:** 8/26/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `docs/user-focused-core-concepts` --- ### 📝 Commits (1) - [`90271bf`](https://github.com/kvcache-ai/AgentENV/commit/90271bfcf0514908e85abe8955489e3bdf3385b9) docs: refocus core concepts on user workflows ### 📊 Changes **17 files changed** (+936 additions, -530 deletions) <details> <summary>View changed files</summary> 📝 `docs/src/SUMMARY.md` (+6 -10) ➕ `docs/src/concepts/authentication.md` (+220 -0) 📝 `docs/src/concepts/custom-extension.md` (+67 -32) 📝 `docs/src/concepts/overview.md` (+59 -34) 📝 `docs/src/concepts/proxy.md` (+23 -8) 📝 `docs/src/concepts/sandboxes.md` (+309 -71) 📝 `docs/src/concepts/snapshots.md` (+110 -177) 📝 `docs/src/concepts/templates.md` (+54 -58) 📝 `docs/src/configuration/env-vars.md` (+1 -1) 📝 `docs/src/deployment/kubernetes.md` (+3 -2) 📝 `docs/src/deployment/static-multi-node.md` (+11 -0) 📝 `docs/src/getting-started/aenv-cli.md` (+28 -13) 📝 `docs/src/internals/architecture.md` (+13 -0) 📝 `docs/src/internals/networking.md` (+3 -1) 📝 `docs/src/internals/persistence-artifact-inventory.md` (+29 -0) ➖ `docs/src/security/authentication.md` (+0 -61) ➖ `docs/src/security/secure-sandboxes.md` (+0 -62) </details> ### 📄 Description ## What Reorganize AgentENV documentation around user workflows and CLI operations. This PR: - Reorganizes the docs. - Revises the Core Concepts documentation for templates, sandboxes, snapshots, custom extensions, proxying, and authentication. - Removes Developer Internals from the public documentation navigation. ## Why The existing documentation focused heavily on implementation details while providing limited guidance for users operating AgentENV. ## Related issue N/A ## Scope and non-goals Included: - Documentation. Not included: - AgentENV behavior changes. ## Design and behavior changes N/A ## Compatibility and operations - Public API or generated protocol: N/A - Configuration or defaults: N/A - Snapshot manifest, artifact layout, or storage format: N/A - Upgrade and rollback: N/A - Host requirements, permissions, ports, or dependencies: No AgentENV runtime changes. Reading the internal mdBook locally requires `mdbook` and `mdbook-mermaid`. ## Validation - [ ] `make fmt` - [ ] `make clippy` - [ ] `make test-unit` - [ ] Relevant Rust integration tests - [ ] `make -C services test` (required when `services/` changes) - [ ] Generated clients/server regenerated with the documented `make` target - [x] Documentation updated - [ ] Benchmarks or performance comparison completed ## Risks and reviewer notes  ## Checklist - [x] The PR contains one coherent change and no unrelated formatting or refactoring. - [x] New behavior is covered by tests, or I explained why testing is impractical. - [x] Logs and examples contain no credentials, tokens, or private registry information. - [x] I did not manually edit generated code without updating its source and regenerating it. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

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