[PR #278] [MERGED] docs: reorganize documentation and add sub-pages

## 📋 Pull Request Information **Original PR:** https://github.com/kvcache-ai/AgentENV/pull/278 **Author:** [@zlzGithub-0801](https://github.com/zlzGithub-0801) **Created:** 9/11/2026 **Status:** ✅ Merged **Merged:** 9/12/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `docs/reorganize-docs` --- ### 📝 Commits (1) - [`80fc894`](https://github.com/kvcache-ai/AgentENV/commit/80fc8941c55e8a3de8a171f87236443bbe013103) docs: reorganize documentation and add sub-pages ### 📊 Changes **52 files changed** (+2062 additions, -2026 deletions) <details> <summary>View changed files</summary> 📝 `docs/book.toml` (+4 -0) 📝 `docs/src/SUMMARY.md` (+34 -8) ➖ `docs/src/concepts/authentication.md` (+0 -227) ➕ `docs/src/concepts/authentication/access-token-seed.md` (+52 -0) ➕ `docs/src/concepts/authentication/api-authentication.md` (+77 -0) ➕ `docs/src/concepts/authentication/application-ingress.md` (+41 -0) ➕ `docs/src/concepts/authentication/index.md` (+25 -0) ➕ `docs/src/concepts/authentication/secure-sandbox.md` (+51 -0) ➕ `docs/src/concepts/custom-extension/connect-and-use.md` (+83 -0) ➕ `docs/src/concepts/custom-extension/index.md` (+17 -0) 📝 `docs/src/concepts/custom-extension/lifecycle-hooks.md` (+4 -89) 📝 `docs/src/concepts/overview.md` (+2 -2) ➖ `docs/src/concepts/sandboxes.md` (+0 -493) ➕ `docs/src/concepts/sandboxes/auto-eviction.md` (+84 -0) ➕ `docs/src/concepts/sandboxes/index.md` (+43 -0) ➕ `docs/src/concepts/sandboxes/networking.md` (+106 -0) 📝 `docs/src/concepts/sandboxes/proxy.md` (+0 -0) ➕ `docs/src/concepts/sandboxes/starting.md` (+94 -0) ➕ `docs/src/concepts/sandboxes/working.md` (+163 -0) ➖ `docs/src/concepts/snapshots.md` (+0 -185) _...and 32 more files_ </details> ### 📄 Description ## What Reorganize the Core Concepts and aenv CLI documentation into focused subpages. ## Why Several documentation pages had become too long and difficult to navigate. The CLI reference also needed to match the latest command implementation. ## Related issue N/A — no issue provided. ## Scope and non-goals Includes documentation structure, internal links, CLI parameter descriptions, and BuildKit template-build documentation. No runtime behavior, API, configuration, or storage format is changed. ## Design and behavior changes Documentation-only change. Core Concepts and CLI topics now use nested pages. User-facing template documentation focuses on commands, startup behavior, build capacity, and monitoring; worker lifecycle details are documented under Developer Internals. ## Compatibility and operations - Public API or generated protocol: N/A — unchanged. - Configuration or defaults: N/A — existing settings are documented only. - Snapshot manifest, artifact layout, or storage format: N/A — unchanged. - Upgrade and rollback: N/A — documentation-only change. - Host requirements, permissions, ports, or dependencies: N/A — unchanged. ## 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 Skipped checks and reasons: Code, generated protocol, service, integration, and benchmark checks were skipped because this PR changes documentation only. ## Risks and reviewer notes Low risk. Review the new navigation in `docs/src/SUMMARY.md`, the template build documentation, and the relocated BuildKit internals. ## 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 commented

2026-10-29 14:22:04 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/AgentENV/pull/278
Author: @zlzGithub-0801
Created: 9/11/2026
Status: ✅ Merged
Merged: 9/12/2026
Merged by: @yingdi-shan

Base: main ← Head: docs/reorganize-docs

📝 Commits (1)

80fc894 docs: reorganize documentation and add sub-pages

📊 Changes

52 files changed (+2062 additions, -2026 deletions)

View changed files

📝 docs/book.toml (+4 -0)
📝 docs/src/SUMMARY.md (+34 -8)
➖ docs/src/concepts/authentication.md (+0 -227)
➕ docs/src/concepts/authentication/access-token-seed.md (+52 -0)
➕ docs/src/concepts/authentication/api-authentication.md (+77 -0)
➕ docs/src/concepts/authentication/application-ingress.md (+41 -0)
➕ docs/src/concepts/authentication/index.md (+25 -0)
➕ docs/src/concepts/authentication/secure-sandbox.md (+51 -0)
➕ docs/src/concepts/custom-extension/connect-and-use.md (+83 -0)
➕ docs/src/concepts/custom-extension/index.md (+17 -0)
📝 docs/src/concepts/custom-extension/lifecycle-hooks.md (+4 -89)
📝 docs/src/concepts/overview.md (+2 -2)
➖ docs/src/concepts/sandboxes.md (+0 -493)
➕ docs/src/concepts/sandboxes/auto-eviction.md (+84 -0)
➕ docs/src/concepts/sandboxes/index.md (+43 -0)
➕ docs/src/concepts/sandboxes/networking.md (+106 -0)
📝 docs/src/concepts/sandboxes/proxy.md (+0 -0)
➕ docs/src/concepts/sandboxes/starting.md (+94 -0)
➕ docs/src/concepts/sandboxes/working.md (+163 -0)
➖ docs/src/concepts/snapshots.md (+0 -185)

...and 32 more files

📄 Description

What

Reorganize the Core Concepts and aenv CLI documentation into focused subpages.

Why

Several documentation pages had become too long and difficult to navigate. The CLI reference also needed to match the latest command implementation.

N/A — no issue provided.

Scope and non-goals

Includes documentation structure, internal links, CLI parameter descriptions, and BuildKit template-build documentation. No runtime behavior, API, configuration, or storage format is changed.

Design and behavior changes

Documentation-only change. Core Concepts and CLI topics now use nested pages. User-facing template documentation focuses on commands, startup behavior, build capacity, and monitoring; worker lifecycle details are documented under Developer Internals.

Compatibility and operations

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

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

Skipped checks and reasons:

Code, generated protocol, service, integration, and benchmark checks were skipped because this PR changes documentation only.

Risks and reviewer notes

Low risk. Review the new navigation in docs/src/SUMMARY.md, the template build documentation, and the relocated BuildKit internals.

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.}

bsakaguchi

2026-10-29 14:22:05 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-10-29 14:22:23 +00:00

[PR #313] [CLOSED] fix(setup): suppress ifupdown hotplug ifquery storm for aenv-* NICs #339

Rows
Columns

[PR #278] [MERGED] docs: reorganize documentation and add sub-pages #312