[PR #290] [MERGED] docs: clarify template builder workflow

bsakaguchi commented

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

Owner

📋 Pull Request Information

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

Base: main ← Head: docs/simplify-template-builder-docs

📝 Commits (1)

a239d80 docs: clarify template builder workflow

📊 Changes

2 files changed (+6 additions, -13 deletions)

View changed files

📝 docs/src/concepts/templates/creating.md (+3 -4)
📝 src/api/openapi.yml (+3 -9)

📄 Description

What

Simplify the Template Builder descriptions in the OpenAPI specification and clarify the template creation documentation.

Why

The existing Template Builder API descriptions included more implementation and lifecycle detail than other OpenAPI descriptions.

N/A

Scope and non-goals

Included:

Template Builder descriptions in src/api/openapi.yml.
Build monitoring and Dockerfile/runtime guidance in docs/src/concepts/templates/creating.md.

Not included:

AgentENV behaviors

Design and behavior changes

No runtime behavior changes.

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: N/A

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:

Formatting, Clippy, unit tests, integration tests, and benchmarks were skipped because this change only updates documentation and OpenAPI descriptions.
Service tests were skipped because no files under services/ changed.
Generated clients and server were not regenerated because no request or response structure changed.

Risks and reviewer notes

Risk is limited to documentation accuracy; runtime behavior is unchanged.

Reviewers should focus on:

Whether “Build a template from a Dockerfile” is the desired public description for the managed BuildKit workflow.
The monitoring behavior documented in docs/src/concepts/templates/creating.md.
The connection between the final Dockerfile stage and runtime configuration.

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/290 **Author:** [@zlzGithub-0801](https://github.com/zlzGithub-0801) **Created:** 9/15/2026 **Status:** ✅ Merged **Merged:** 9/15/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `docs/simplify-template-builder-docs` --- ### 📝 Commits (1) - [`a239d80`](https://github.com/kvcache-ai/AgentENV/commit/a239d802c11340a74d6e6fa06e7c2558cb003dc2) docs: clarify template builder workflow ### 📊 Changes **2 files changed** (+6 additions, -13 deletions) <details> <summary>View changed files</summary> 📝 `docs/src/concepts/templates/creating.md` (+3 -4) 📝 `src/api/openapi.yml` (+3 -9) </details> ### 📄 Description ## What Simplify the Template Builder descriptions in the OpenAPI specification and clarify the template creation documentation. ## Why The existing Template Builder API descriptions included more implementation and lifecycle detail than other OpenAPI descriptions. ## Related issue N/A ## Scope and non-goals Included: - Template Builder descriptions in `src/api/openapi.yml`. - Build monitoring and Dockerfile/runtime guidance in `docs/src/concepts/templates/creating.md`. Not included: - AgentENV behaviors ## Design and behavior changes No runtime behavior changes. ## 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: N/A ## 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: - Formatting, Clippy, unit tests, integration tests, and benchmarks were skipped because this change only updates documentation and OpenAPI descriptions. - Service tests were skipped because no files under `services/` changed. - Generated clients and server were not regenerated because no request or response structure changed. ## Risks and reviewer notes Risk is limited to documentation accuracy; runtime behavior is unchanged. Reviewers should focus on: - Whether “Build a template from a Dockerfile” is the desired public description for the managed BuildKit workflow. - The monitoring behavior documented in `docs/src/concepts/templates/creating.md`. - The connection between the final Dockerfile stage and runtime configuration. ## 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:22:10 +00:00