[PR #235] [MERGED] docs: polish API reference layout

bsakaguchi commented

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

Owner

📋 Pull Request Information

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

Base: main ← Head: docs/polish-api-reference

📝 Commits (1)

299f1db docs: polish API reference layout

📊 Changes

1 file changed (+22 additions, -4 deletions)

View changed files

📝 docs/src/stoplight-elements.html (+22 -4)

📄 Description

What

Polish the API reference navigation and layout.

Why

Improve readability and make API groups and request samples easier to scan.

N/A

Scope and non-goals

Documentation-only changes.

Design and behavior changes

Capitalize API navigation group names.
Widen the request sample panel.
Increase the request and response sample font size.

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:

Rust, service, generated-code, and benchmark checks were skipped because this PR only changes documentation presentation.

Risks and reviewer notes

N/A.

Checklist

The PR contains one coherent change and no unrelated formatting or refactoring.
New behavior is covered by documentation build validation; runtime tests are not applicable.
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/235 **Author:** [@zlzGithub-0801](https://github.com/zlzGithub-0801) **Created:** 9/1/2026 **Status:** ✅ Merged **Merged:** 9/1/2026 **Merged by:** [@yingdi-shan](https://github.com/yingdi-shan) **Base:** `main` ← **Head:** `docs/polish-api-reference` --- ### 📝 Commits (1) - [`299f1db`](https://github.com/kvcache-ai/AgentENV/commit/299f1db78ee46bc323cd60fdabf26d92240b35ff) docs: polish API reference layout ### 📊 Changes **1 file changed** (+22 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `docs/src/stoplight-elements.html` (+22 -4) </details> ### 📄 Description ## What Polish the API reference navigation and layout. ## Why Improve readability and make API groups and request samples easier to scan. ## Related issue N/A ## Scope and non-goals Documentation-only changes. ## Design and behavior changes - Capitalize API navigation group names. - Widen the request sample panel. - Increase the request and response sample font size. ## 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: Rust, service, generated-code, and benchmark checks were skipped because this PR only changes documentation presentation. ## Risks and reviewer notes N/A. ## Checklist - [x] The PR contains one coherent change and no unrelated formatting or refactoring. - [x] New behavior is covered by documentation build validation; runtime tests are not applicable. - [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